De-version Change Tracker docs - #1291
Conversation
Change Tracker docs were split across 8.0/8.1/8.2 folders, which meant version-scoped links broke every time a version was retired. Converted Change Tracker to a single unversioned "current" product (matching PolicyPak's pattern) so URLs stay stable across releases. Flattened docs/changetracker/8.2 -> docs/changetracker, moved the sidebar and images to their unversioned locations, rewrote internal cross-links and image references, updated the OpenAPI plugin config and generation scripts, and dropped the 8.0/8.1 versions entirely.
|
@claude fix all issues |
|
Fix complete:
Summary: The code review flagged one build-breaking issue: the OpenAPI plugin
Note: an equivalent fix landed on the branch concurrently (commit |
The OpenAPI plugin id was renamed to openapi-changetracker, but the gen-api-docs/clean-api-docs invocations still relied on the default --plugin-id of "openapi". With no plugin instance named "openapi", a clean CI checkout could not resolve the target instance and the API reference failed to generate, breaking prestart/prebuild/preci and openapi:sync. Add --plugin-id openapi-changetracker to all four. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
|
Fixed the one build-breaking issue from the code review in 9c90511. OpenAPI Added
Everything else in the review was noted as correct, so no other changes were needed.
|
|
@claude fix all issues |
|
Fix complete:
Summary: This PR has no editorial "Documentation PR Review" comment (it's a config/refactor PR, not doc-content changes). The only review is the Code Review, which found no blocking issues — the one build-breaker (OpenAPI
Nothing else in the review required changes. |
The docs/changetracker/8.1/integration/api/reference entry is fully subsumed by the docs/changetracker/8.1 entry, which removes it recursively. Flagged as redundant in the PR code review. Co-Authored-By: Claude <[email protected]>
|
Reviewed the outstanding issues — everything actionable is already resolved on the branch. I went through the code review's findings against the current branch state:
Not a defect — no change made:
All CI checks (build, code-review, doc-review, vale-autofix, CodeQL) are currently passing. Nothing further to fix. |
Code ReviewI reviewed the non-content changes in this PR (config, scripts, Verdict: No build-breaking or correctness bugs foundThe de-versioning changes are internally consistent and correctly follow the established single-version
Non-blocking consideration (routing)Because Change Tracker is now a single-version |
Summary
docs/changetracker/8.2intodocs/changetracker, moved the sidebar and images to their unversioned locations, and rewrote all internal cross-links and image references.package.jsongen-api-docs scripts, and.gitignorefor the new unversioned API reference path.Test plan
npm run startbuild with no errors introduced by this change (pre-existing tag-redirect build issue confirmed present ondevbaseline too)Closes #1292