docs: fix module "Related" links and the showcase library note - #69
Merged
Merged
Conversation
The "Related" lists at the end of the auth, keycloak and permission module docs linked ./sd-*.md siblings that do not exist, so all ten links returned 404 on GitHub and in the raw published docs; the showcase only resolved them through its basename fallback. They now point at ../<module>/sd-<module>.md and ../../services/cache/sd-cache.md, which also match the showcase doc ids exactly. Edited in versions/v19 and rolled out with npm run sync. CLAUDE.md and AGENTS.md said the showcase resolves @sdcorejs/angular through a tsconfig path into versions/v19/dist. It resolves ./node_modules/@sdcorejs/angular, which npm run link:library fills with a copy of the built library. prestart, prebuild and build:page run that step; npm test does not. Both files now say so and name the --legacy-peer-deps install that the showcase lockfile needs. Verification: npm run check:sync; npm run test:scripts (0 failures); repo-internal Markdown link scan, 0 of 195 links broken (40 before). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
2 participants
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.
Summary
./sd-*.mdsiblings that do not exist, so they returned 404 on GitHub and in the rawpublished-docsarchives that AI agents fetch. The showcase only found the targets through its basename fallback.CLAUDE.mdandAGENTS.md, in the same commit as the repo rules require.Changes
versions/v19/projects/sdcorejs-angular/modules/{auth,keycloak,permission}/sd-*.md:./sd-<module>.mdbecomes../<module>/sd-<module>.md, and../services/sd-cache.mdbecomes../../services/cache/sd-cache.md. The v20, v21 and v22 copies come fromnpm run syncand are identical. The sync's EOL-only rewrites and theSYNC-STATUS.mdtimestamp changes were restored, so only these files changed.CLAUDE.md,AGENTS.md: the showcase resolves@sdcorejs/angularfrom./node_modules/@sdcorejs/angular, not through a tsconfig path intoversions/v19/dist.npm run link:librarycopiesversions/v19/dist/sdcorejs-angularthere. It is a copy, not a symlink, because a symlink would load a second Angular and fail with NG0203.prestart,prebuildandbuild:pagerun the link step;npm testdoes not. The showcase installs withnpm --prefix showcase ci --legacy-peer-deps, because plainnpm cifails withEUSAGE.CHANGELOG.md: one[Unreleased] > Fixedline for the doc links.Verification
All on Node 22.22.3 and the committed HEAD:
npm run check:sync: passed.npm run test:scripts: passed, 0 failures..mdfiles outsidepublished-*: 0 of 195 links broken, against 40 broken onmain.publishedDocIdvalues in the showcase registry, so the docs site no longer needs the basename fallback for them.Risks and rollback
This PR changes docs only, with no library, showcase or workflow code. Reverting the commit rolls it back.
published-pages/**andpublished-docs/**are untouched: archived releases keep the old links, and the next release'scollect-docsrun publishes the fixed ones.🤖 Generated with Claude Code