[codex] fix stale user API doc links and sidebar entries#125
Merged
Conversation
Deploying qf-api-docs with
|
| Latest commit: |
eadfd86
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c400450a.qf-api-docs.pages.dev |
| Branch Preview URL: | https://codex-remove-stale-featured.qf-api-docs.pages.dev |
basit3407
force-pushed
the
codex/remove-stale-featured-user-sidebar-links
branch
from
b12f1a1 to
259582d
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes docs build issues caused by stale User API sidebar entries and outdated hardcoded links to User API endpoint docs.
Changes:
- Removes injection of stale “featured users” doc IDs from the shared User API sidebar helper.
- Updates manual MDX links to point at newer (operationId-style) User API doc slugs.
- Updates versioned and unversioned “Reading Sessions vs Activity Days” pages’ related-links section.
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| sidebars.js | Stops injecting the removed “featured users” doc IDs into the User-related APIs sidebar structure. |
| docs/user-related-apis/reading-sessions-vs-activity-days.mdx | Updates “Related API Docs” links to new endpoint doc slugs. |
| docs/user-related-apis/1.0.0/reading-sessions-vs-activity-days.mdx | Same link updates for v1.0.0 page. |
| docs/tutorials/oidc/example-integration.mdx | Updates OIDC tutorial links for Collections/Bookmarks to new endpoint doc slugs. |
💡 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.
What changed
Why
There were two separate docs build breaks:
sidebars.jsstill injected featured-user doc IDs that are no longer generatedadd-collection,get-all-collections, andadd-update-activity-dayThis PR fixes the docs repo side of both issues. A matching backend source-of-truth PR updates the reading-session description so future OpenAPI syncs do not reintroduce the stale generated link.
Validation
yarn clean-allyarn build