Skip to content

Commit 122f2a6

Browse files
author
Clément Le Provost
committed
[doc] Improve offline Jazzy documentation layout
- Group classes in sidebar sections. - Use the offline mode guide as an overview for the section (I had to rename the file and remove the main heading). [ci skip]
1 parent 10af88f commit 122f2a6

File tree

2 files changed

+24
-5
lines changed

2 files changed

+24
-5
lines changed

doc/offline-mode.md renamed to doc/Offline mode.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11

22

3-
# Offline mode
4-
53
## Overview
64

75
The API client can be enhanced with offline capabilities. This optional **offline mode** allows you to mirror online indices on local storage, and transparently switch to the local mirror in case of unavailability of the online index, thus providing uninterrupted user experience. You can also explicitly query the mirror if you want.
@@ -210,4 +208,3 @@ If you have a crash in the offline core, please send us a support request. Make
210208
## Other resources
211209
212210
The offline client bears extensive documentation comments. Please refer to them for more details.
213-

offline.jazzy.yaml

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,33 @@ xcodebuild_arguments:
55
- AlgoliaSearch.xcworkspace
66
- -scheme
77
- AlgoliaSearch-Offline-iOS
8-
documentation:
9-
- doc/offline-mode.md
108
output: build/doc
119
# Avoid putting the DocSet within the HTML docs.
1210
# WARNING: The path is relative to the output directory.
1311
docset_path: ../docset
1412
hide_documentation_coverage: true
1513
skip_undocumented: true
14+
15+
custom_categories:
16+
- name: API Client
17+
children:
18+
- Client
19+
- Index
20+
- Query
21+
- BrowseIterator
22+
23+
- name: Auxiliary types
24+
children:
25+
- GeoRect
26+
- IndexQuery
27+
- LatLng
28+
- LibraryVersion
29+
30+
- name: Offline mode
31+
children:
32+
- OfflineClient
33+
- MirroredIndex
34+
- DataSelectionQuery
35+
36+
abstract:
37+
- doc/Offline mode.md

0 commit comments

Comments
 (0)