Skip to content

Commit 1ebad79

Browse files
committed
docs: Split API and guide sidebars
1 parent 1ce07be commit 1ebad79

File tree

3 files changed

+136
-142
lines changed

3 files changed

+136
-142
lines changed

docs/core/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Introducing the Reactive Data Client
33
sidebar_label: Introduction
44
description: Building delightful dynamic applications with NextJS, Expo, React Native and more.
55
slug: /
6+
id: introduction
67
---
78

89
import ThemedImage from '@theme/ThemedImage';

website/docusaurus.config.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -405,15 +405,16 @@ const config: Config = {
405405
hideOnScroll: true,
406406
items: [
407407
{
408-
to: 'docs',
409-
label: 'Docs',
408+
type: 'doc',
410409
position: 'left',
410+
docId: 'introduction',
411+
label: 'Docs',
411412
},
412413
{
413-
to: 'docs/api/useSuspense',
414-
label: 'Hooks',
414+
type: 'docSidebar',
415415
position: 'left',
416-
activeBasePath: '/donotuse',
416+
sidebarId: 'api',
417+
label: 'API',
417418
},
418419
{
419420
to: 'rest',

website/sidebars.json

Lines changed: 129 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"docs": [
33
{
44
"type": "doc",
5-
"id": "README"
5+
"id": "introduction"
66
},
77
{
88
"type": "category",
@@ -70,7 +70,6 @@
7070
"type": "category",
7171
"label": "Tooling",
7272
"items": [
73-
7473
{
7574
"type": "doc",
7675
"id": "guides/storybook"
@@ -136,163 +135,156 @@
136135
]
137136
}
138137
]
138+
}
139+
],
140+
"api": [
141+
{
142+
"type": "category",
143+
"label": "Hooks",
144+
"items": [
145+
{
146+
"type": "doc",
147+
"id": "api/useSuspense"
148+
},
149+
{
150+
"type": "doc",
151+
"id": "api/useController"
152+
},
153+
{
154+
"type": "doc",
155+
"id": "api/useCache"
156+
},
157+
{
158+
"type": "doc",
159+
"id": "api/useQuery"
160+
},
161+
{
162+
"type": "doc",
163+
"id": "api/useLive"
164+
},
165+
{
166+
"type": "doc",
167+
"id": "api/useSubscription"
168+
},
169+
{
170+
"type": "doc",
171+
"id": "api/useFetch"
172+
},
173+
{
174+
"type": "doc",
175+
"id": "api/useDLE"
176+
},
177+
{
178+
"type": "doc",
179+
"id": "api/useError"
180+
},
181+
{
182+
"type": "doc",
183+
"id": "api/useLoading"
184+
},
185+
{
186+
"type": "doc",
187+
"id": "api/useDebounce"
188+
},
189+
{
190+
"type": "doc",
191+
"id": "api/useCancelling"
192+
}
193+
]
194+
},
195+
{
196+
"type": "doc",
197+
"id": "api/Controller"
198+
},
199+
{
200+
"type": "doc",
201+
"id": "api/Snapshot"
139202
},
140203
{
141204
"type": "category",
142-
"label": "API",
205+
"label": "Components",
143206
"items": [
144-
145207
{
146208
"type": "doc",
147-
"id": "api/Controller"
209+
"id": "api/DataProvider"
148210
},
149211
{
150212
"type": "doc",
151-
"id": "api/Snapshot"
213+
"id": "api/ExternalDataProvider"
152214
},
153215
{
154-
"type": "category",
155-
"label": "Hooks",
156-
"items": [
157-
158-
{
159-
"type": "doc",
160-
"id": "api/useSuspense"
161-
},
162-
{
163-
"type": "doc",
164-
"id": "api/useController"
165-
},
166-
{
167-
"type": "doc",
168-
"id": "api/useCache"
169-
},
170-
{
171-
"type": "doc",
172-
"id": "api/useQuery"
173-
},
174-
{
175-
"type": "doc",
176-
"id": "api/useLive"
177-
},
178-
{
179-
"type": "doc",
180-
"id": "api/useSubscription"
181-
},
182-
{
183-
"type": "doc",
184-
"id": "api/useFetch"
185-
},
186-
{
187-
"type": "doc",
188-
"id": "api/useDLE"
189-
},
190-
{
191-
"type": "doc",
192-
"id": "api/useError"
193-
},
194-
{
195-
"type": "doc",
196-
"id": "api/useLoading"
197-
},
198-
{
199-
"type": "doc",
200-
"id": "api/useDebounce"
201-
},
202-
{
203-
"type": "doc",
204-
"id": "api/useCancelling"
205-
}
206-
]
216+
"type": "doc",
217+
"id": "api/AsyncBoundary"
207218
},
208219
{
209-
"type": "category",
210-
"label": "Components",
211-
"items": [
212-
{
213-
"type": "doc",
214-
"id": "api/DataProvider"
215-
},
216-
{
217-
"type": "doc",
218-
"id": "api/ExternalDataProvider"
219-
},
220-
{
221-
"type": "doc",
222-
"id": "api/AsyncBoundary"
223-
},
224-
{
225-
"type": "doc",
226-
"id": "api/ErrorBoundary"
227-
}
228-
]
220+
"type": "doc",
221+
"id": "api/ErrorBoundary"
222+
}
223+
]
224+
},
225+
{
226+
"type": "category",
227+
"label": "Managers",
228+
"items": [
229+
{
230+
"type": "doc",
231+
"id": "api/Manager"
229232
},
230233
{
231-
"type": "category",
232-
"label": "Managers",
233-
"items": [
234-
{
235-
"type": "doc",
236-
"id": "api/Manager"
237-
},
238-
{
239-
"type": "doc",
240-
"id": "api/Actions"
241-
},
242-
{
243-
"type": "doc",
244-
"id": "api/getDefaultManagers"
245-
},
246-
{
247-
"type": "doc",
248-
"id": "api/NetworkManager"
249-
},
250-
{
251-
"type": "doc",
252-
"id": "api/SubscriptionManager"
253-
},
254-
{
255-
"type": "doc",
256-
"id": "api/PollingSubscription"
257-
},
258-
{
259-
"type": "doc",
260-
"id": "api/DevToolsManager"
261-
},
262-
{
263-
"type": "doc",
264-
"id": "api/LogoutManager"
265-
}
266-
]
234+
"type": "doc",
235+
"id": "api/Actions"
267236
},
268237
{
269-
"type": "category",
270-
"label": "Testing",
271-
"items": [
272-
{
273-
"type": "doc",
274-
"id": "api/Fixtures"
275-
},
276-
{
277-
"type": "doc",
278-
"id": "api/MockResolver"
279-
},
280-
{
281-
"type": "doc",
282-
"id": "api/makeRenderDataClient"
283-
},
284-
{
285-
"type": "doc",
286-
"id": "api/mockInitialState"
287-
}
288-
]
238+
"type": "doc",
239+
"id": "api/getDefaultManagers"
240+
},
241+
{
242+
"type": "doc",
243+
"id": "api/NetworkManager"
244+
},
245+
{
246+
"type": "doc",
247+
"id": "api/SubscriptionManager"
248+
},
249+
{
250+
"type": "doc",
251+
"id": "api/PollingSubscription"
289252
},
290253
{
291254
"type": "doc",
292-
"id": "api/types"
255+
"id": "api/DevToolsManager"
256+
},
257+
{
258+
"type": "doc",
259+
"id": "api/LogoutManager"
293260
}
294261
]
262+
},
263+
{
264+
"type": "category",
265+
"label": "Testing",
266+
"items": [
267+
{
268+
"type": "doc",
269+
"id": "api/Fixtures"
270+
},
271+
{
272+
"type": "doc",
273+
"id": "api/MockResolver"
274+
},
275+
{
276+
"type": "doc",
277+
"id": "api/makeRenderDataClient"
278+
},
279+
{
280+
"type": "doc",
281+
"id": "api/mockInitialState"
282+
}
283+
]
284+
},
285+
{
286+
"type": "doc",
287+
"id": "api/types"
295288
}
296-
297289
]
298290
}

0 commit comments

Comments
 (0)