Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/tutorials/oidc/example-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ const bookmarks = await response.json();

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

- **[Collections](/docs/user_related_apis_versioned/add-collection)** — Create and manage verse collections
- **[Bookmarks](/docs/user_related_apis_versioned/get-all-collections)** — Save and retrieve bookmarked verses
- **[Collections](/docs/user_related_apis_versioned/auth-get-v-1-collections)** — Create and manage verse collections
- **[Bookmarks](/docs/user_related_apis_versioned/auth-get-v-1-bookmarks)** — Save and retrieve bookmarked verses
Comment thread
basit3407 marked this conversation as resolved.
- **Reading Sessions** — Track reading progress
- **Goals & Streaks** — User reading goals

Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/sync/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ When the user creates data offline, push mutations to the server using `POST /v1

### API References

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

## Using metadataOnly for Efficiency

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

For the full request/response schema, see:

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

## Filtering & Pagination

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/sync/handling-conflicts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ This quickly retrieves the current `lastMutationAt` without fetching all mutatio

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

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

## Best Practices

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ Tracks daily activity/progress (by date + type). This powers streaks, goals, and

## Related API Docs (v1.0.0)

- [Add or update user reading session](/docs/user_related_apis_versioned/1.0.0/add-or-update-user-reading-session)
- [Get user reading sessions](/docs/user_related_apis_versioned/1.0.0/get-user-reading-sessions)
- [Add/update activity day](/docs/user_related_apis_versioned/1.0.0/add-update-activity-day)
- [Get activity days](/docs/user_related_apis_versioned/1.0.0/get-activity-days)
- [Estimate reading time](/docs/user_related_apis_versioned/1.0.0/estimate-reading-time)
- [Add or update user reading session](/docs/user_related_apis_versioned/1.0.0/auth-post-v-1-reading-sessions)
- [Get user reading sessions](/docs/user_related_apis_versioned/1.0.0/auth-get-v-1-reading-sessions)
- [Add/update activity day](/docs/user_related_apis_versioned/1.0.0/auth-post-v-1-activity-days)
- [Get activity days](/docs/user_related_apis_versioned/1.0.0/auth-get-v-1-activity-days)
- [Estimate reading time](/docs/user_related_apis_versioned/1.0.0/auth-get-v-1-activity-days-estimate-reading-time)
Comment thread
basit3407 marked this conversation as resolved.

10 changes: 5 additions & 5 deletions docs/user-related-apis/reading-sessions-vs-activity-days.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ Tracks daily activity/progress (by date + type). This powers streaks, goals, and

## Related API Docs

- [Add or update user reading session](/docs/user_related_apis_versioned/add-or-update-user-reading-session)
- [Get user reading sessions](/docs/user_related_apis_versioned/get-user-reading-sessions)
- [Add/update activity day](/docs/user_related_apis_versioned/add-update-activity-day)
- [Get activity days](/docs/user_related_apis_versioned/get-activity-days)
- [Estimate reading time](/docs/user_related_apis_versioned/estimate-reading-time)
- [Add or update user reading session](/docs/user_related_apis_versioned/auth-post-v-1-reading-sessions)
- [Get user reading sessions](/docs/user_related_apis_versioned/auth-get-v-1-reading-sessions)
- [Add/update activity day](/docs/user_related_apis_versioned/auth-post-v-1-activity-days)
- [Get activity days](/docs/user_related_apis_versioned/auth-get-v-1-activity-days)
- [Estimate reading time](/docs/user_related_apis_versioned/auth-get-v-1-activity-days-estimate-reading-time)
Comment thread
basit3407 marked this conversation as resolved.

2 changes: 1 addition & 1 deletion openAPI/user-related-apis/pre-live/v1.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openAPI/user-related-apis/v1.json

Large diffs are not rendered by default.

23 changes: 2 additions & 21 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -189,27 +189,9 @@ const ensureDocsInCategory = (items, categoryLabel, docsToEnsure, afterDocId) =>
];
};

const extendUserRelatedApisSidebarItems = (items, baseDocIdPrefix) => {
const withUsersEndpoints = insertDocsIntoCategory(
const extendUserRelatedApisSidebarItems = (items, baseDocIdPrefix) =>
insertDocsIntoCategory(
items,
"Users",
[
makeApiDocSidebarItem(
`${baseDocIdPrefix}/users-controller-get-featured-users`,
"Get featured users for follow recommendation",
"api-method get",
),
makeApiDocSidebarItem(
`${baseDocIdPrefix}/users-controller-follow-featured-users`,
"Follow all featured users",
"api-method post",
),
],
`${baseDocIdPrefix}/users-controller-search`,
);

return insertDocsIntoCategory(
withUsersEndpoints,
"Posts",
[
makeApiDocSidebarItem(
Expand All @@ -220,7 +202,6 @@ const extendUserRelatedApisSidebarItems = (items, baseDocIdPrefix) => {
],
`${baseDocIdPrefix}/posts-controller-find-one`,
);
};

const extendContentApisSidebarItems = (items, baseDocIdPrefix) =>
ensureDocsInCategory(
Expand Down