Skip to content

Restructured the realtime docs #2317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
d17fe9d
Reordered react hooks + frontend sections
D-K-P Jul 25, 2025
0c4e8ac
Updated the overview and nav
D-K-P Jul 25, 2025
f9cf164
Separated out SWR hooks
D-K-P Jul 25, 2025
f3dab2a
Restructured metadata sections
D-K-P Jul 25, 2025
d60cfaf
Improved backend docs
D-K-P Jul 25, 2025
a6fc9c5
Fixed broken link
D-K-P Jul 25, 2025
1a8cf5b
Fixed broken links
D-K-P Jul 28, 2025
fd37ce7
Updated the structure
D-K-P Jul 31, 2025
f57581e
Restructured overview
D-K-P Jul 31, 2025
048ec36
Updated examples cards
D-K-P Jul 31, 2025
b6d97e7
Improved overview
D-K-P Jul 31, 2025
8849168
Updated how it works
D-K-P Jul 31, 2025
f8f21ea
Updated auth
D-K-P Jul 31, 2025
e7b0eaa
Added type safety to the run object page
D-K-P Jul 31, 2025
e210535
made the subscribe description clearer
D-K-P Jul 31, 2025
d89e9b8
Fixed links in triggering
D-K-P Jul 31, 2025
8a89eef
Fixed link
D-K-P Jul 31, 2025
663613e
Removed examples footers
D-K-P Jul 31, 2025
3412fb3
Copy tweak
D-K-P Jul 31, 2025
f5da2f5
Consolidated metadata and subscribe pages
D-K-P Jul 31, 2025
f807f1a
moved metadata task examples to metadata
D-K-P Aug 1, 2025
3189c4c
Merge branch 'main' into docs/realtime-docs-updates
D-K-P Aug 1, 2025
129f089
Fixed links
D-K-P Aug 1, 2025
a8202ed
Fixing links like zelda
D-K-P Aug 1, 2025
4cc2529
Removed dead import
D-K-P Aug 1, 2025
acb2338
Merge branch 'main' into docs/realtime-docs-updates
D-K-P Aug 1, 2025
86b39da
Merge branch 'main' into docs/realtime-docs-updates
D-K-P Aug 1, 2025
4921a98
Clearer titles
D-K-P Aug 1, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 60 additions & 18 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -113,30 +113,32 @@
]
},
{
"group": "Frontend usage",
"group": "Realtime",
"pages": [
"frontend/overview",
"realtime/overview",
"realtime/how-it-works",
"realtime/run-object",
"realtime/auth",
{
"group": "React hooks (frontend)",
"pages": [
"realtime/react-hooks/overview",
"realtime/react-hooks/triggering",
"realtime/react-hooks/subscribe",
"realtime/react-hooks/streams",
"realtime/react-hooks/swr"
]
},
{
"group": "React hooks",
"group": "Backend",
"pages": [
"frontend/react-hooks/overview",
"frontend/react-hooks/realtime",
"frontend/react-hooks/triggering"
"realtime/backend/overview",
"realtime/backend/subscribe",
"realtime/backend/streams"
]
}
]
},
{
"group": "Realtime API",
"pages": [
"realtime/overview",
"realtime/streams",
"realtime/react-hooks",
"realtime/subscribe-to-run",
"realtime/subscribe-to-runs-with-tag",
"realtime/subscribe-to-batch"
]
},
{
"group": "CLI",
"pages": [
Expand Down Expand Up @@ -573,7 +575,47 @@
},
{
"source": "/frontend/react-hooks",
"destination": "/frontend/react-hooks/overview"
"destination": "/realtime/react-hooks/overview"
},
{
"source": "/frontend/overview",
"destination": "/realtime/auth"
},
{
"source": "/frontend/react-hooks/overview",
"destination": "/realtime/react-hooks/overview"
},
{
"source": "/frontend/react-hooks/realtime",
"destination": "/realtime/react-hooks/realtime"
},
{
"source": "/frontend/react-hooks/triggering",
"destination": "/realtime/react-hooks/triggering"
},
{
"source": "/realtime/backend",
"destination": "/realtime/backend/overview"
},
{
"source": "/realtime/streams",
"destination": "/realtime/backend/streams"
},
{
"source": "/realtime/react-hooks",
"destination": "/realtime/react-hooks/overview"
},
{
"source": "/realtime/subscribe-to-run",
"destination": "/realtime/backend/subscribe"
},
{
"source": "/realtime/subscribe-to-runs-with-tag",
"destination": "/realtime/backend/subscribe"
},
{
"source": "/realtime/subscribe-to-batch",
"destination": "/realtime/backend/subscribe"
},
{
"source": "/management/projects/runs",
Expand Down
171 changes: 0 additions & 171 deletions docs/frontend/overview.mdx

This file was deleted.

Loading