diff --git a/openspec/changes/add-initial-readme/proposal.md b/openspec/changes/archive/2025-11-19-add-initial-readme/proposal.md similarity index 100% rename from openspec/changes/add-initial-readme/proposal.md rename to openspec/changes/archive/2025-11-19-add-initial-readme/proposal.md diff --git a/openspec/changes/add-initial-readme/specs/project-documentation/spec.md b/openspec/changes/archive/2025-11-19-add-initial-readme/specs/project-documentation/spec.md similarity index 100% rename from openspec/changes/add-initial-readme/specs/project-documentation/spec.md rename to openspec/changes/archive/2025-11-19-add-initial-readme/specs/project-documentation/spec.md diff --git a/openspec/changes/add-initial-readme/tasks.md b/openspec/changes/archive/2025-11-19-add-initial-readme/tasks.md similarity index 100% rename from openspec/changes/add-initial-readme/tasks.md rename to openspec/changes/archive/2025-11-19-add-initial-readme/tasks.md diff --git a/openspec/specs/project-documentation/spec.md b/openspec/specs/project-documentation/spec.md new file mode 100644 index 0000000..452519a --- /dev/null +++ b/openspec/specs/project-documentation/spec.md @@ -0,0 +1,36 @@ +# project-documentation Specification + +## Purpose +This specification defines requirements for project documentation, ensuring the repository has clear, accurate, and up-to-date documentation that serves as the entry point for developers and AI assistants. +## Requirements +### Requirement: README File +The project root SHALL contain a README.md file that serves as the primary entry point for developers and AI assistants. + +#### Scenario: Repository discovery +- **WHEN** a developer or AI assistant discovers the repository +- **THEN** they can read README.md to understand project purpose and current state + +### Requirement: Current State Documentation +The README.md SHALL accurately describe only the current implementation state, not planned features. + +#### Scenario: Accurate project status +- **WHEN** reading the README.md +- **THEN** it reflects what is actually implemented +- **AND** does not promise or describe unimplemented features + +### Requirement: Getting Started Guide +The README.md SHALL include instructions for contributors to get started with development. + +#### Scenario: New contributor onboarding +- **WHEN** a new contributor wants to start developing +- **THEN** README.md provides clear setup steps +- **AND** explains the OpenSpec-based workflow + +### Requirement: OpenSpec Reference +The README.md SHALL reference the OpenSpec documentation structure for detailed specifications. + +#### Scenario: Finding detailed specs +- **WHEN** a developer needs detailed technical specifications +- **THEN** README.md directs them to the `openspec/` directory +- **AND** explains how to read and create proposals +