Sitelet https://github.com/sdcorejs/sdcorejs-angular/pull/67
Skip to content

docs(readme): point example-source links at the root showcase - #67

Merged
sdcorejs merged 2 commits into
mainfrom
claude/relaxed-murdock-60a3e4
Sep 30, 2026
Merged

sdcorejs merged 2 commits into
mainfrom
claude/relaxed-murdock-60a3e4

Conversation

@sdcorejs

Copy link
Copy Markdown
Owner

Summary

The showcase moved from versions/v19/projects/showcase to the root showcase/ 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 at showcase/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 absolute https://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 relative showcase/src/app/pages/... paths.
  • versions/v{19,20,21,22}/projects/sdcorejs-angular/README.md: rolled out from README.npm.md with npm run sync, not edited by hand.
  • versions/v{19,20,21,22}/eslint.config.js: removed the dead projects/showcase/src/app/docs/generated/**/*.ts ignore and its comment. The lint target only covers projects/sdcorejs-angular, so nothing matched that ignore. The pdf worker ignore stays. v20, v21 and v22 come from npm run sync.
  • .sdcorejs/summary.md: the showcase source root is now showcase.

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/** and published-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").
  • All 28 showcase links in the six READMEs resolve to tracked files under showcase/src/app/pages/. No README mentions projects/showcase any more.
  • ESLint 9 Node API: all four eslint.config.js files load. pdf-worker-inline.generated.ts is still ignored, and library files are still linted with prettier/prettier.
  • npm run test:check-scss-hex: 9/9 passed. This test lints with the v19 ESLint config.
  • Prettier 3.8.3 --check: the four ESLint configs and .sdcorejs/summary.md pass.
  • npm run sync also rewrote 1163 v22 files with CRLF line endings only and bumped the four SYNC-STATUS.md timestamps. I restored those files, so the diff holds only the 11 intended files.

Not run locally: test:theme and test:theme-token-list need versions/v19/node_modules for their sass load paths, and this worktree has no node_modules. Neither test reads a changed file. CI runs both, and it also runs lint and the full ng test suite.

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

🤖 Generated with Claude Code

nghiatt15 and others added 2 commits September 30, 2026 14:49
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>
@sdcorejs
sdcorejs merged commit 03695a0 into main Sep 30, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants