docs: sync docs with actual stack - #447
Merged
Merged
Conversation
Docs truth-sweep against ground truth (package.json, CI workflows): - npm → pnpm across evergreen docs (pnpm 11.25.0 is the package manager; npx tsx → pnpm exec tsx, npx ts-prune/jscpd → pnpm dlx, npm ci → pnpm install --frozen-lockfile, package-lock.json → pnpm-lock.yaml) - Jest → Vitest in README, CONTRIBUTING, COMMANDS (vitest 4 is installed) - Node claims: README 20+ → 22.13+ (engines) with CI/deploy on 24; deployment.md "Setup Node 20 (npm cache)" → Node 24 (pnpm cache), and the pipeline line now shows `pnpm run verify` as CI actually runs - TypeScript 5.x claims → 6 (typescript ^6.0.3); Next.js 14 → 16 in BLOG_SYSTEM, guides/ARCHITECTURE, AI_BOT_SYSTEM_PROMPT - COMMANDS.md: dropped nonexistent `dev:cms` script; services list fixed to db/meilisearch/listmonk (no redis in compose) - HR_RUNBOOK: `npm run test -- src/…` → `pnpm run test src/…` (pnpm passes args without the `--` separator) Historical records (docs/archive/**, dated audit reports, UPGRADE_PLAN) left as-is — they describe what was true when written. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WqKqMnHQHSmkGFfc5t7Rxn
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
1 participant
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.
Docs truth-sweep for evig, verified against package.json and the CI workflows before every edit:
pnpm@11.25.0):npm run→pnpm run,npm ci→pnpm install --frozen-lockfile,npx tsx→pnpm exec tsx(tsx is a dep),npx ts-prune/jscpd→pnpm dlx,package-lock.json→pnpm-lock.yamlengines, noting CI/deploy run Node 24;deployment.md"Setup Node 20 (npm cache)" → Node 24 (pnpm cache), pipeline line now showspnpm run verify(what deploy-selfhost.yml actually runs)dev:cmsscript; Docker services list corrected to db/meilisearch/listmonk (compose has no redis)--separator (pnpm run test src/…)Left untouched: docs/archive/**, dated audit reports, UPGRADE_PLAN — historical records. Legacy revampit-era guides (system-integration, cms-solution) kept their npm references since they describe external/old systems; note
cms-api/no longer exists in-repo though installation/backend guides still mention it.Gates:
pnpm run lint:docsOK (baseline 68 held, 0 primary), prettier check clean.🤖 Generated with Claude Code