Open
Conversation
Deploying qf-api-docs with
|
| Latest commit: |
cca632c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a544699b.qf-api-docs.pages.dev |
| Branch Preview URL: | https://sync-apis.qf-api-docs.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the documentation site to reflect the new offline-first Sync API flow and related OAuth/OIDC improvements, including updated API reference parameters and nav structure.
Changes:
- Reworked Tutorials sidebar to add a “Mobile Apps” section and introduced dedicated Offline-first Sync tutorials.
- Updated multiple user-related API reference pages to reflect new sync/concurrency fields (e.g.,
lastMutationAt,X-Mutation-At) and new profile fields. - Expanded OIDC logout docs with RP-Initiated Logout parameters (
post_logout_redirect_uri,state,id_token_hint).
Reviewed changes
Copilot reviewed 39 out of 114 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.js | Restructures tutorials navigation; adds Mobile Apps + Offline-first Sync sections |
| docs/user_related_apis_versioned/users-controller-edit-profile.api.mdx | Documents new hideFollowSuggestion profile field |
| docs/user_related_apis_versioned/tags-controller-find.api.mdx | Refreshes response examples |
| docs/user_related_apis_versioned/scopes.mdx | Adds sync scope documentation |
| docs/user_related_apis_versioned/rooms-controller-get-rooms.api.mdx | Adds sortBy query param |
| docs/user_related_apis_versioned/posts-controller-get-all-comment.api.mdx | Refreshes response examples |
| docs/user_related_apis_versioned/get-notes-by-verse.api.mdx | Refreshes pagination examples (but retains param/path mismatch) |
| docs/user_related_apis_versioned/get-all-notes.api.mdx | Normalizes /v1/notes path + updates examples |
| docs/user_related_apis_versioned/delete-note-by-id.api.mdx | Adds lastMutationAt, 409 docs, and X-Mutation-At header rendering |
| docs/user_related_apis_versioned/delete-a-goal.api.mdx | Extends goal category enum |
| docs/user_related_apis_versioned/comments-controller-create.api.mdx | Refreshes response examples |
| docs/user_related_apis_versioned/add-update-activity-day.api.mdx | Normalizes /v1/activity-days path |
| docs/user_related_apis_versioned/add-or-update-user-reading-session.api.mdx | Normalizes /v1/reading-sessions path |
| docs/user_related_apis_versioned/1.0.0/* | Mirrors the above user-related API doc changes for v1.0.0 |
| docs/tutorials/sync/getting-started.mdx | New Sync getting started guide |
| docs/tutorials/sync/handling-conflicts.mdx | New guide for 409 conflict handling |
| docs/tutorials/sync/offline-first-patterns.mdx | New offline-first architecture patterns guide |
| docs/tutorials/sync/category.json | Adds category metadata for Sync tutorial section |
| docs/tutorials/oidc/example-integration.mdx | Fixes a small formatting issue + updates “Next steps” link |
| docs/oauth2_apis_versioned/revoke-oidc-session.api.mdx | Documents RP-initiated logout query params |
| docs/oauth2_apis_versioned/1.0.0/revoke-oidc-session.api.mdx | Same RP-initiated logout updates for v1.0.0 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes QF-79