Skip to content

Commit fad2bf1

Browse files
author
Clément Le Provost
committed
[doc] Use a specific home page instead of the full README
Using the full README was misleading, because it is also available on Algolia’s main website (as well as GitHub, of course). [ci skip]
1 parent db02125 commit fad2bf1

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

doc/reference.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
3+
# Algolia Search API Client for Swift
4+
5+
This is the reference documentation for the **Algolia Search API Client for Swift**. You can always browse the latest version online at [Algolia Community](https://community.algolia.com/algoliasearch-client-swift/).
6+
7+
**Note:** *This documentation is automatically generated from sources.* For an overview of how Algolia works, detailed setup and usage instructions, please refer to our [Documentation](https://www.algolia.com/doc), in particular to the [Swift API Client](https://www.algolia.com/doc/api-client/swift/) documentation.

offline.jazzy.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ output: build/doc
1111
docset_path: ../docset
1212
hide_documentation_coverage: true
1313
skip_undocumented: true
14-
14+
readme: doc/reference.md
1515
custom_categories:
1616
- name: API Client
1717
children:
@@ -32,6 +32,5 @@ custom_categories:
3232
- OfflineClient
3333
- MirroredIndex
3434
- DataSelectionQuery
35-
3635
abstract:
3736
- doc/Offline mode.md

0 commit comments

Comments
 (0)