Docs as specs: source of truth for app behavior #47
Conversation
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
- Remove Agent Workflow section from README (aspirational, not implemented) - Move agent workflow ideas to ROADMAP.md for future reference - Delete docs/DBOS.md (external library docs don't belong in repo) - Update architecture.md to simplify session types description - Add context7 guidance to CLAUDE.md for fetching external docs - Fix DBOS link in README to point to official docs Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Agent workflow: spawn → work in k8s ns → PR → close - Emphasizes staying in main thread while agents work - Trim ROADMAP.md to just future automation features Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add docs/specs/ with chat.md, sessions.md, layout.md - Specs are human-readable but detailed enough for planner agent - Delete question-answering tests (feature removed) - Update CLAUDE.md: specs → planner → tests workflow - Update README: link to specs as primary docs Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Skill validates that all README features are documented in specs and covered by tests. Outputs a coverage report with gaps. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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.
Summary
docs/specs/are the source of truth/validate-docsskill to audit README → spec → test coverageChanges
Added
docs/specs/chat.md- Main thread conversation specdocs/specs/sessions.md- Sessions and notifications specdocs/specs/layout.md- Mobile/desktop layout spec.claude/skills/validate-docs/SKILL.md- Coverage validation skillROADMAP.md- Project roadmapRemoved
docs/DBOS.md- Outdated DBOS documentation (1400+ lines)Updated
Test plan
/validate-docsand verify output matches expected format🤖 Generated with Claude Code