Skip to content

Commit 59ec83b

Browse files
authored
[codex] fix stale user API doc links and sidebar entries (#125)
* fix: remove stale featured user sidebar links * fix: update stale user API doc links * fix: update stale sync tutorial links
1 parent 8dab8bd commit 59ec83b

8 files changed

Lines changed: 20 additions & 39 deletions

File tree

‎docs/tutorials/oidc/example-integration.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ const bookmarks = await response.json();
8080

8181
Once authenticated, explore the [User APIs](/docs/category/user-related-apis):
8282

83-
- **[Collections](/docs/user_related_apis_versioned/add-collection)** — Create and manage verse collections
84-
- **[Bookmarks](/docs/user_related_apis_versioned/get-all-collections)** — Save and retrieve bookmarked verses
83+
- **[Collections](/docs/user_related_apis_versioned/auth-get-v-1-collections)** — Create and manage verse collections
84+
- **[Bookmarks](/docs/user_related_apis_versioned/auth-get-v-1-bookmarks)** — Save and retrieve bookmarked verses
8585
- **Reading Sessions** — Track reading progress
8686
- **Goals & Streaks** — User reading goals
8787

‎docs/tutorials/sync/getting-started.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ When the user creates data offline, push mutations to the server using `POST /v1
124124

125125
### API References
126126

127-
- [GET /v1/sync (Get mutations)](/docs/user_related_apis_prelive/get-mutations)
128-
- [POST /v1/sync (Sync local mutations)](/docs/user_related_apis_prelive/sync-local-mutations)
127+
- [GET /v1/sync (Get mutations)](/docs/user_related_apis_prelive/auth-get-v-1-sync)
128+
- [POST /v1/sync (Sync local mutations)](/docs/user_related_apis_prelive/auth-post-v-1-sync)
129129

130130
## Using metadataOnly for Efficiency
131131

@@ -139,7 +139,7 @@ This is significantly faster than a full sync (single DB query vs multiple joins
139139

140140
For the full request/response schema, see:
141141

142-
- [GET /v1/sync (Get mutations)](/docs/user_related_apis_prelive/get-mutations)
142+
- [GET /v1/sync (Get mutations)](/docs/user_related_apis_prelive/auth-get-v-1-sync)
143143

144144
## Filtering & Pagination
145145

‎docs/tutorials/sync/handling-conflicts.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ This quickly retrieves the current `lastMutationAt` without fetching all mutatio
117117

118118
See the full request/response schema in the API reference:
119119

120-
- [GET /v1/sync (Get mutations)](/docs/user_related_apis_prelive/get-mutations)
120+
- [GET /v1/sync (Get mutations)](/docs/user_related_apis_prelive/auth-get-v-1-sync)
121121

122122
## Best Practices
123123

‎docs/user-related-apis/1.0.0/reading-sessions-vs-activity-days.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ Tracks daily activity/progress (by date + type). This powers streaks, goals, and
2828

2929
## Related API Docs (v1.0.0)
3030

31-
- [Add or update user reading session](/docs/user_related_apis_versioned/1.0.0/add-or-update-user-reading-session)
32-
- [Get user reading sessions](/docs/user_related_apis_versioned/1.0.0/get-user-reading-sessions)
33-
- [Add/update activity day](/docs/user_related_apis_versioned/1.0.0/add-update-activity-day)
34-
- [Get activity days](/docs/user_related_apis_versioned/1.0.0/get-activity-days)
35-
- [Estimate reading time](/docs/user_related_apis_versioned/1.0.0/estimate-reading-time)
31+
- [Add or update user reading session](/docs/user_related_apis_versioned/1.0.0/auth-post-v-1-reading-sessions)
32+
- [Get user reading sessions](/docs/user_related_apis_versioned/1.0.0/auth-get-v-1-reading-sessions)
33+
- [Add/update activity day](/docs/user_related_apis_versioned/1.0.0/auth-post-v-1-activity-days)
34+
- [Get activity days](/docs/user_related_apis_versioned/1.0.0/auth-get-v-1-activity-days)
35+
- [Estimate reading time](/docs/user_related_apis_versioned/1.0.0/auth-get-v-1-activity-days-estimate-reading-time)
3636

‎docs/user-related-apis/reading-sessions-vs-activity-days.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ Tracks daily activity/progress (by date + type). This powers streaks, goals, and
2828

2929
## Related API Docs
3030

31-
- [Add or update user reading session](/docs/user_related_apis_versioned/add-or-update-user-reading-session)
32-
- [Get user reading sessions](/docs/user_related_apis_versioned/get-user-reading-sessions)
33-
- [Add/update activity day](/docs/user_related_apis_versioned/add-update-activity-day)
34-
- [Get activity days](/docs/user_related_apis_versioned/get-activity-days)
35-
- [Estimate reading time](/docs/user_related_apis_versioned/estimate-reading-time)
31+
- [Add or update user reading session](/docs/user_related_apis_versioned/auth-post-v-1-reading-sessions)
32+
- [Get user reading sessions](/docs/user_related_apis_versioned/auth-get-v-1-reading-sessions)
33+
- [Add/update activity day](/docs/user_related_apis_versioned/auth-post-v-1-activity-days)
34+
- [Get activity days](/docs/user_related_apis_versioned/auth-get-v-1-activity-days)
35+
- [Estimate reading time](/docs/user_related_apis_versioned/auth-get-v-1-activity-days-estimate-reading-time)
3636

‎openAPI/user-related-apis/pre-live/v1.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎openAPI/user-related-apis/v1.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎sidebars.js‎

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -189,27 +189,9 @@ const ensureDocsInCategory = (items, categoryLabel, docsToEnsure, afterDocId) =>
189189
];
190190
};
191191

192-
const extendUserRelatedApisSidebarItems = (items, baseDocIdPrefix) => {
193-
const withUsersEndpoints = insertDocsIntoCategory(
192+
const extendUserRelatedApisSidebarItems = (items, baseDocIdPrefix) =>
193+
insertDocsIntoCategory(
194194
items,
195-
"Users",
196-
[
197-
makeApiDocSidebarItem(
198-
`${baseDocIdPrefix}/users-controller-get-featured-users`,
199-
"Get featured users for follow recommendation",
200-
"api-method get",
201-
),
202-
makeApiDocSidebarItem(
203-
`${baseDocIdPrefix}/users-controller-follow-featured-users`,
204-
"Follow all featured users",
205-
"api-method post",
206-
),
207-
],
208-
`${baseDocIdPrefix}/users-controller-search`,
209-
);
210-
211-
return insertDocsIntoCategory(
212-
withUsersEndpoints,
213195
"Posts",
214196
[
215197
makeApiDocSidebarItem(
@@ -220,7 +202,6 @@ const extendUserRelatedApisSidebarItems = (items, baseDocIdPrefix) => {
220202
],
221203
`${baseDocIdPrefix}/posts-controller-find-one`,
222204
);
223-
};
224205

225206
const extendContentApisSidebarItems = (items, baseDocIdPrefix) =>
226207
ensureDocsInCategory(

0 commit comments

Comments
 (0)