Skip to content

Route CLI documentation by task - #24

Merged
raghubetina merged 1 commit into
mainfrom
codex/streamline-cli-documentation
Aug 13, 2026
Merged

Route CLI documentation by task#24
raghubetina merged 1 commit into
mainfrom
codex/streamline-cli-documentation

Conversation

@raghubetina

Copy link
Copy Markdown
Contributor

Summary

  • reduce the public README from 23.1 KB to 4.5 KB and keep the shortest supported journey visible
  • route detailed command, recovery, release-policy, and dated-history knowledge to distinct owners
  • add repository-wide documentation link checks and explicitly keep repository docs outside the npm package

Verification

  • npm run check — 153/153 tests plus typecheck, lint, formatting, package allowlist, and packed smoke
  • npm audit — 0 vulnerabilities
  • npm pack --dry-run --json --ignore-scripts — 20 entries, no docs/
  • independent documentation review — pass, no remaining findings

Boundaries

This changes documentation and documentation/package-boundary checks only. It does not change CLI runtime behavior, versions, package contents, dist-tags, publication state, or release authorization.

Keep public onboarding short while preserving command, recovery, release, and historical details behind explicit authority routes. Strengthen link and package-boundary checks so the split cannot drift.
@raghubetina
raghubetina merged commit 535970c into main Aug 13, 2026
4 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