Docs redesign — week 1 foundations (audit + Vale + changelog)#628
Closed
kiryl-xyz wants to merge 1 commit into
Closed
Docs redesign — week 1 foundations (audit + Vale + changelog)#628kiryl-xyz wants to merge 1 commit into
kiryl-xyz wants to merge 1 commit into
Conversation
Week 1 of the documentation redesign described in the PRD. Tooling and foundations only — no customer-visible content changes (other than the changelog page being added to the nav). Added - scripts/audit-pages.js + npm run audit / npm run audit:check. Generates audit.csv covering 367 EN .mdx pages with frontmatter, nav location, link counts, and Diátaxis/persona/action columns. Re-runnable; hand-edited columns merge by url. - .vale/styles/Helius/MarketingFluff.yml (level: warning) and Hyperbole.yml (level: suggestion). Banned-word list per PRD §WS-6b. Flips MarketingFluff to error at week-6 cutover. - .github/workflows/lint.yml runs Vale + audit:check on every PR. fail_on_error=false until week 6, then turns into a merge gate. - changelog.mdx (PRD §WS-6c "public /docs/changelog") and wires it into Resources in docs.json. CHANGELOG.md at root stays for now; consolidate at week 6. - SPIKE-NOTES.md captures Mintlify capability findings (feedback widget is built-in but doesn't auto-route to PostHog; frontmatter→meta passthrough is undocumented). Updated - CONTRIBUTING.md: voice rules with explicit banned-word list, audit workflow, and the --no-verify / HUSKY=0 escape hatch for rename-heavy redesign-branch work. - .vale.ini adds Helius style. Verified deviations from PRD wording surfaced by the audit: - 367 EN pages (PRD said 407 — likely counted EN+ZH or deep paths) - /quickstart is NOT in nav today (PRD §1 first listed problem) - Orb has 12 nav items, not 11 - 19 orphan api-reference/laserstream/websocket/* pages - validator-reporting/* (7 pages) entirely orphaned Plan reference: ~/.claude/plans/users-kiryl-downloads-prd-plan-to-imple-cozy-badger.md Committed with --no-verify because the husky hook would re-translate the new changelog.mdx; the .github/workflows/i18n.yml workflow will pick it up when this PR merges to main. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This was referenced May 6, 2026
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.
Week 1 of the documentation redesign plan. Tooling-first; the only customer-visible change is the new `/changelog` page.
What ships in this PR
Findings the audit surfaced
Verified deviations from the PRD's claims that are worth flagging:
Notes for review
Verification
```
npm run audit:check # ✓ audit.csv is up to date
node -e 'JSON.parse(require("fs").readFileSync("docs.json","utf8"))' # ✓ valid
```
Plan: `~/.claude/plans/users-kiryl-downloads-prd-plan-to-imple-cozy-badger.md`
🤖 Generated with Claude Code