Skip to content

Commit 9e41e83

Browse files
D-K-Psamejr
andauthored
Restructured the realtime docs (#2317)
* Reordered react hooks + frontend sections * Updated the overview and nav * Separated out SWR hooks * Restructured metadata sections * Improved backend docs * Fixed broken link * Fixed broken links * Updated the structure * Restructured overview * Updated examples cards * Improved overview * Updated how it works * Updated auth * Added type safety to the run object page * made the subscribe description clearer * Fixed links in triggering * Fixed link * Removed examples footers * Copy tweak * Consolidated metadata and subscribe pages * moved metadata task examples to metadata * Fixed links * Fixing links like zelda * Removed dead import * Clearer titles * Cap R for Realtime * Fixes broken link --------- Co-authored-by: James Ritchie <[email protected]>
1 parent da7dc74 commit 9e41e83

33 files changed

+2017
-1590
lines changed

docs/docs.json

Lines changed: 60 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -131,30 +131,32 @@
131131
]
132132
},
133133
{
134-
"group": "Frontend usage",
134+
"group": "Realtime",
135135
"pages": [
136-
"frontend/overview",
136+
"realtime/overview",
137+
"realtime/how-it-works",
138+
"realtime/run-object",
139+
"realtime/auth",
140+
{
141+
"group": "React hooks (frontend)",
142+
"pages": [
143+
"realtime/react-hooks/overview",
144+
"realtime/react-hooks/triggering",
145+
"realtime/react-hooks/subscribe",
146+
"realtime/react-hooks/streams",
147+
"realtime/react-hooks/swr"
148+
]
149+
},
137150
{
138-
"group": "React hooks",
151+
"group": "Backend",
139152
"pages": [
140-
"frontend/react-hooks/overview",
141-
"frontend/react-hooks/realtime",
142-
"frontend/react-hooks/triggering"
153+
"realtime/backend/overview",
154+
"realtime/backend/subscribe",
155+
"realtime/backend/streams"
143156
]
144157
}
145158
]
146159
},
147-
{
148-
"group": "Realtime API",
149-
"pages": [
150-
"realtime/overview",
151-
"realtime/streams",
152-
"realtime/react-hooks",
153-
"realtime/subscribe-to-run",
154-
"realtime/subscribe-to-runs-with-tag",
155-
"realtime/subscribe-to-batch"
156-
]
157-
},
158160
{
159161
"group": "CLI",
160162
"pages": [
@@ -621,7 +623,47 @@
621623
},
622624
{
623625
"source": "/frontend/react-hooks",
624-
"destination": "/frontend/react-hooks/overview"
626+
"destination": "/realtime/react-hooks/overview"
627+
},
628+
{
629+
"source": "/frontend/overview",
630+
"destination": "/realtime/auth"
631+
},
632+
{
633+
"source": "/frontend/react-hooks/overview",
634+
"destination": "/realtime/react-hooks/overview"
635+
},
636+
{
637+
"source": "/frontend/react-hooks/realtime",
638+
"destination": "/realtime/react-hooks/realtime"
639+
},
640+
{
641+
"source": "/frontend/react-hooks/triggering",
642+
"destination": "/realtime/react-hooks/triggering"
643+
},
644+
{
645+
"source": "/realtime/backend",
646+
"destination": "/realtime/backend/overview"
647+
},
648+
{
649+
"source": "/realtime/streams",
650+
"destination": "/realtime/backend/streams"
651+
},
652+
{
653+
"source": "/realtime/react-hooks",
654+
"destination": "/realtime/react-hooks/overview"
655+
},
656+
{
657+
"source": "/realtime/subscribe-to-run",
658+
"destination": "/realtime/backend/subscribe"
659+
},
660+
{
661+
"source": "/realtime/subscribe-to-runs-with-tag",
662+
"destination": "/realtime/backend/subscribe"
663+
},
664+
{
665+
"source": "/realtime/subscribe-to-batch",
666+
"destination": "/realtime/backend/subscribe"
625667
},
626668
{
627669
"source": "/management/projects/runs",

docs/frontend/overview.mdx

Lines changed: 0 additions & 171 deletions
This file was deleted.

0 commit comments

Comments
 (0)