[codex] restore search console indexing cleanup#141
Merged
Conversation
Deploying qf-api-docs with
|
| Latest commit: |
94371a0
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://010967ac.qf-api-docs.pages.dev |
| Branch Preview URL: | https://codex-search-console-indexin.qf-api-docs.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Restores and extends the Search Console indexing cleanup workflow by pruning generated alias docs, normalizing API sidebar output, and post-processing the built site so canonicals/sitemap consistently prefer versioned API URLs.
Changes:
- Adds generated sidebar cleanup that removes references to pruned/missing API docs, plus a unit test for the behavior.
- Adds post-generation pruning for generated
auth-*.api.mdxalias docs and a post-build SEO normalization step (canonicals + sitemap rewriting). - Updates Docusaurus config and internal docs links to prefer versioned, trailing-slash canonical API URLs.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/api-sidebar-cleanup.test.cjs | Adds unit coverage for filtering/cleanup of generated sidebar items. |
| static/_redirects | Normalizes commented redirect examples (formatting). |
| src/pages/legal/developer-terms.mdx | Fixes legal doc link target to an absolute /legal/.../ route. |
| scripts/set-api-displayed-sidebars.js | Adds missing-doc sidebar filtering and exposes functions for testing. |
| scripts/prune-generated-api-aliases.js | Deletes generated auth-*.api.mdx alias docs after generation. |
| scripts/postbuild-seo.js | Rewrites built HTML canonicals/og:url and normalizes sitemap URLs/entries. |
| package.json | Wires new cleanup + SEO steps into gen-all and build. |
| docusaurus.config.js | Enables trailingSlash and updates navbar links + sitemap ignore patterns. |
| docs/user-related-apis/reading-sessions-vs-activity-days.mdx | Updates related links to preferred versioned API doc URLs. |
| docs/user-related-apis/1.0.0/reading-sessions-vs-activity-days.mdx | Updates versioned doc’s related links to preferred versioned API doc URLs. |
| docs/tutorials/sync/handling-conflicts.mdx | Fixes API reference + tutorial next-step links to new canonical targets. |
| docs/tutorials/sync/getting-started.mdx | Fixes API reference + next-step links to new canonical targets. |
| docs/tutorials/oidc/example-integration.mdx | Updates user API links to preferred versioned endpoints. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…indexing-cleanup-refresh # Conflicts: # openAPI/user-related-apis/pre-live/v1.json
…indexing-cleanup-refresh # Conflicts: # openAPI/user-related-apis/pre-live/v1.json
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
mainauth-*.api.mdxalias docsWhy
#131 had the right functional scope but never landed because the branch accumulated Cloudflare debugging churn and was later replaced by
#136, which only carried a small subset of the original work. This PR recreates the actual intended #131 end state cleanly from currentmain.Not included
.node-versionpinImpact
Validation
CI=truepostbuild-seo.jscompleted successfullyReplaces