feat(docs): add redirect and anchor checks for renamed pages - #173
penielgold-hub wants to merge 6 commits into
Conversation
|
@penielgold-hub Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
|
The unit tests for path and anchor parsing pass, but the issue also requires testing redirects in the docs preview. Please add a preview or browser check that requests an old URL and verifies the real redirect destination. |
1 similar comment
|
The unit tests for path and anchor parsing pass, but the issue also requires testing redirects in the docs preview. Please add a preview or browser check that requests an old URL and verifies the real redirect destination. |
|
Thanks for the review. I’ve addressed the preview-validation request. Added a real HTTP smoke check that:
The check is available as The existing PR workflow does not expose the per-PR Mintlify preview URL, so the check is documented to run against the actual preview once it is available. The latest commit is |
|
The smoke script is useful, but it is not run in CI and there is no successful run against the PR preview. Please wire the preview URL into CI or attach a successful run from the actual Mintlify preview. |
|
Thanks for the clarification. I investigated the preview path further. PR #173 is a fork-based PR ( The smoke check is implemented and ready to run against a real preview, but I cannot truthfully attach a successful preview run without access to a Mintlify deployment for this fork's commit. Mintlify's fork-preview limitation means an upstream maintainer would need to make the PR commit available on an upstream branch and create/trigger the corresponding preview. Once that preview URL is available, I can run:
against it and attach the successful result here. I have not claimed a preview run that I could not actually perform. |
|
The preview redirect script is added, but the workflow still never runs test:preview-redirect or supplies MINTLIFY_PREVIEW_URL. Please wire that command into CI against the real preview. |
|
Thanks. I’ve confirmed that the current Wraith workflow does not expose a Mintlify preview URL for this fork PR or provide a preview deployment status for commit The HTTP smoke test is implemented and ready to run once the real preview URL is available. Please provide or enable the Mintlify preview for this PR (or an upstream branch containing |
6fe89f9 to
82f959b
Compare
|
There is another gap in the checker: when a heading changes, it only scans links inside changed pages. Unchanged pages that still point to the old anchor are skipped. Scan all shipped pages when docs change and add a fixture for an unchanged inbound link. The preview redirect test also still needs a real CI run. |
|
Thanks for the continued review. The redirect/anchor validation has now been updated to address the inbound-link scenario, including coverage for unchanged pages that reference anchors on documentation pages being changed. The local validation and focused tests have been run, and the PR is ready for further attention from the maintainer. The remaining preview-related validation depends on access to an actual Mintlify preview for this fork PR, as discussed. Please let me know if there is any further adjustment or validation you would like us to make. |
|
The inbound scan fix works, and CI now finds the existing broken links. Please resolve or explicitly scope the reported placeholder links, missing pages, and stale anchors so the gate passes. The preview redirect test still needs a real run too. |
|
Thanks — the CI findings from the broader inbound-link scan have now been resolved in
Validation is green:
The remaining item is the real preview redirect run. Ready for further review. |
|
The link checks are green, but the restored event schema is inaccurate. The current contract documents v1 topics as announce, scheme ID, and stealth address. V2 requires scheme 2 and metadata kind 1, and its data has no caller. Please align the page with stellar/stealth-announcer/src/lib.rs. The preview run is still pending too. |
|
Thanks for the review. I’ve updated
Local validation passes:
Fix commit: The real Mintlify preview run remains pending because the PR branch has not been deployed. |
|
The event schema is correct now. The only remaining item from #163 is a successful redirect check against a real docs preview. There is still no preview URL or run attached to this PR. |
|
Thanks for confirming that the event schema is correct. Understood — the real docs preview redirect check is the only remaining item. At the moment, GitHub shows that this branch has not been deployed, so there is no preview URL available for me to run the check against. Could you please advise whether there is a maintainer-side workflow/deployment that can generate the required docs preview for this fork PR, or whether there is another approved way for contributors to obtain the preview URL? Once a real preview URL is available, I can run the redirect check against it and report the result here. |
|
There is no maintainer-side preview workflow for fork PRs right now. A local Mintlify preview is acceptable: run |
|
Thanks for the guidance. I’ve now completed the redirect check against a real local Mintlify preview. The preview was running successfully at
Verified http://localhost:51240/README returns 307 redirect to /introduction. This confirms that Please let me know if anything else is needed for #163. |
Summary
/README→/introductionredirectValidation
npm.cmd run test:redirects-and-anchorsnpm.cmd run check:redirects-and-anchorsnpm.cmd run check:nav-coveragegit diff --checkAll passed locally.
closed #163