docs(readme): point example-source links at the root showcase - #67
Merged
Merged
Conversation
The showcase moved from versions/v19/projects/showcase to the root showcase/ workspace on 2026-08-06, so the example-source links in the npm README and in the GitHub README returned 404. - README.npm.md: the Button, Input, Table and Persistence links use https://github.com/sdcorejs/sdcorejs-angular/blob/main/showcase/src/app/pages/... - README.md: the eight example links use showcase/src/app/pages/... - versions/v19-v22 package READMEs: rolled out from README.npm.md with npm run sync, not edited by hand. - .sdcorejs/summary.md: the showcase source root is now showcase. Each edited table row keeps its width, so the tables stay aligned. Verification: npm run check:sync passes; all 28 showcase links in the six READMEs resolve to tracked files under showcase/src/app/pages. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…config versions/v19/eslint.config.js still ignored projects/showcase/src/app/docs/generated/**/*.ts. That path no longer exists since the showcase moved to the root showcase/ workspace, and the lint target only covers projects/sdcorejs-angular. The pdf worker ignore stays. Rolled out to v20, v21 and v22 with npm run sync. Verification: the ESLint 9 Node API loads all four configs; the pdf worker file is still ignored and library files are still linted with the prettier rule; npm run test:check-scss-hex passes (9/9). 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
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
The showcase moved from
versions/v19/projects/showcaseto the rootshowcase/workspace on 2026-08-06. The README example-source links still pointed at the old path, so they returned 404 on GitHub and on the npm package page. This PR points them atshowcase/src/app/pages/<category>/<slug>/<slug>-demo.component.ts. It also removes the last stale reference to the old path, which was in the workspace ESLint config.#66 fixed the same stale path in the showcase "View demo source" links. This PR covers the READMEs.
Changes
README.npm.md(canonical npm README): the Button, Input, Table and Persistence links use absolutehttps://github.com/sdcorejs/sdcorejs-angular/blob/main/showcase/src/app/pages/...URLs.README.md(GitHub landing): the 8 example links in "Explore the library" and "Examples and documentation" use relativeshowcase/src/app/pages/...paths.versions/v{19,20,21,22}/projects/sdcorejs-angular/README.md: rolled out fromREADME.npm.mdwithnpm run sync, not edited by hand.versions/v{19,20,21,22}/eslint.config.js: removed the deadprojects/showcase/src/app/docs/generated/**/*.tsignore and its comment. The lint target only coversprojects/sdcorejs-angular, so nothing matched that ignore. The pdf worker ignore stays. v20, v21 and v22 come fromnpm run sync..sdcorejs/summary.md: the showcase source root is nowshowcase.Each edited table row keeps its width, so the Markdown tables stay aligned. I did not run Prettier over the whole READMEs, because both files already have unrelated table drift that it would reformat.
published-docs/**andpublished-pages/**are untouched, because they are archived release artifacts.Verification
Local runs used Node 22.22.3 on the exact committed diff:
npm run check:sync: passed ("v20, v21, v22 match v19").showcase/src/app/pages/. No README mentionsprojects/showcaseany more.eslint.config.jsfiles load.pdf-worker-inline.generated.tsis still ignored, and library files are still linted withprettier/prettier.npm run test:check-scss-hex: 9/9 passed. This test lints with the v19 ESLint config.--check: the four ESLint configs and.sdcorejs/summary.mdpass.npm run syncalso rewrote 1163 v22 files with CRLF line endings only and bumped the fourSYNC-STATUS.mdtimestamps. I restored those files, so the diff holds only the 11 intended files.Not run locally:
test:themeandtest:theme-token-listneedversions/v19/node_modulesfor their sass load paths, and this worktree has nonode_modules. Neither test reads a changed file. CI runs both, and it also runs lint and the fullng testsuite.Risks and rollback
This PR changes only docs and lint config. There are no changes to library code, public API or package versions. To roll back, revert the two commits.
Notes for reviewer
## [Unreleased]next to the fix(showcase): point "View demo source" links at the root showcase #66 showcase entry..sdcorejs/summary.mdis still an older snapshot elsewhere: it lists only v20/v21 and release 1.4. A full refresh is out of scope.🤖 Generated with Claude Code