Skip to content

Audit documentation language and links#1

Merged
ChuanGz merged 2 commits into
mainfrom
codex/docs-english-link-audit
Jun 28, 2026
Merged

Audit documentation language and links#1
ChuanGz merged 2 commits into
mainfrom
codex/docs-english-link-audit

Conversation

@ChuanGz

@ChuanGz ChuanGz commented Jun 28, 2026

Copy link
Copy Markdown
Owner

Summary

  • improve English clarity and consistency across user and maintainer documentation
  • repair malformed option-reference tables and align guidance with the current option contract
  • replace stale generator paths, generated-project structure, release status, and E2E behavior
  • align package-manager examples with npm repository bootstrap and the primary pnpm generated-app workflow
  • add the roadmap to the documentation index and verify all local Markdown links

Why

Documentation still contained claims and paths from earlier generator layouts. Several option tables were also rendered incorrectly because option values were parsed as Markdown column separators. These issues could mislead users even though the link targets existed.

Validation

  • npm run quality
  • npm run docs:links
  • npm run format:check
  • git diff --check
  • 47/47 tests pass

@ChuanGz ChuanGz changed the title [codex] Audit documentation language and links Audit documentation language and links Jun 28, 2026
@ChuanGz ChuanGz marked this pull request as ready for review June 28, 2026 18:05
@ChuanGz ChuanGz merged commit 7af71a0 into main Jun 28, 2026
9 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.

1 participant