Bootstrap repo-setup with configuration system and documentation standard#1
Merged
Conversation
- Remove project type classification (unified standards for all repos) - Remove excessive SemVer from file naming (Git tracks versions) - Rename to functional-specification.md (no version suffix) - Simplify naming: prj-git-workflow-standard.md (not v1.0.0) - All repos get same three standards: git workflow, testing, MCP usage - Optional project-specific standards can be added as needed
- Collect real-world configuration examples from active projects - Add user-level config examples (CLAUDE.md, prompts, helper scripts) - Add project-level examples: - Comprehensive: gainfunction, marrbox, specverse-app-portal - Simplified: npm-protect (with doc parity protocol) - Document Documentation Parity Protocol in functional spec - Optional standard for CLI/tooling projects - Mandatory doc updates when scripts change - Pre-commit checklist and detection script - Script-level documentation parity requirement - Add examples/README.md documenting all patterns - Remove specverse-lang and scoremyclays (no unique patterns) Examples now provide reference implementations for new projects.
- Add .gitignore (macOS, editors, logs, env files) - Add CLAUDE.md following unified standards approach - Create prompts/ with three standard project prompts - prj-git-workflow-standard.md - prj-testing-standard.md - prj-mcp-usage-standard.md - Create plans/ directory for implementation planning - Update README.md with comprehensive project overview Repo now "eats its own dog food" - demonstrates the configuration system it documents.
- Create prj-documentation-standard.md - Define directory organization (docs/, examples/, plans/, prompts/) - Document standards for each doc type - Quality requirements and anti-patterns - Maintenance workflows - Add startup imperatives to CLAUDE.md - Read all standards in ./prompts/ on startup - Simple, maintenance-free approach (no file enumeration) - Update CLAUDE.md to reference documentation standard - Update functional spec optional standards list This repo now has explicit rules for documentation organization and ensures project-level prompts are loaded when work begins.
- Add prompts/user-documentation-standard.md with Diataxis framework - Mandates four-quadrant content classification (Tutorial/How-To/Reference/Explanation) - Mandates Role-First organization for multi-audience projects - Mandates documentation-code parity for CLI/API projects - Technology-agnostic (no MkDocs/Material specifics) - Move functional spec to research/functional-specification-original.md - Preserves historical analysis and patterns - Clears docs/ for upcoming PRD - Add examples/user-level/prompts/user-standard-for-standards.md - Defines what constitutes a standard (binding constraint on method) - Establishes standard-writing rules Key insight: Diataxis IS a standard because it prescribes method (content classification), not technology. Role-First and Diataxis are orthogonal concerns that compose together. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
2 tasks
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
1 participant
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
This PR establishes the foundational configuration system for repo-setup and creates the first universal standard.
Key Changes
Universal Documentation Standard (
prompts/user-documentation-standard.md)Project Bootstrap
Configuration Examples
Archive Original Spec
docs/functional-specification.mdtoresearch/functional-specification-original.mdKey Insights
Next Steps
After merge:
🤖 Generated with Claude Code