-
Notifications
You must be signed in to change notification settings - Fork 29
Closed
Description
Context
We're preparing for an HN submission of the Tour of CodevOS article. The README was just updated (#557), but the broader documentation needs a thorough review and refresh.
Scope
Audit and update ALL user-facing documentation in the repo. Key areas:
docs/ directory
docs/faq.md— Review for accuracy, add any missing common questionsdocs/tips.md— Ensure tips reflect current CLI commands and workflowsdocs/why.md— Update the narrative with latest results and capabilitiesdocs/releases/— Ensure release notes are current
codev/resources/ (user-facing)
codev/resources/cheatsheet.md— Verify all commands, concepts, and examples are currentcodev/resources/commands/overview.md— CLI command reference accuracycodev/resources/commands/codev.md— codev CLI referencecodev/resources/commands/agent-farm.md— af CLI referencecodev/resources/commands/consult.md— consult CLI reference
Key reference material to incorporate
- Tour of CodevOS: https://waleedk.medium.com/a-tour-of-codevos-1db0fe0e4516
- Latest VIBE vs SPIR comparison (R4):
codev/resources/vibe-vs-spir-r4-comparison-2026-02.md - Development analysis:
codev/resources/development-analysis-2026-02-17.md - Current version: Check
packages/codev/package.jsonfor latest version number
What to look for
- Stale command syntax or outdated CLI examples
- References to old features or removed functionality
- Missing documentation for recent features (porch checks, analytics, workspace scoping, etc.)
- Broken internal links
- Inconsistencies between docs and actual codebase
- Tone: professional, concise, technically credible (HN audience)
AGENTS.md / CLAUDE.md
- Verify these are in sync with each other and with current project state
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels