Skip to content

Commit add35ef

Browse files
committed
docs: add completeness checklist
1 parent 83d2ff5 commit add35ef

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

docs/completeness-checklist.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Completeness Checklist
2+
3+
Use this checklist before claiming the repository is ready.
4+
5+
## Repository structure
6+
7+
- README explains the purpose, loop, and start pages.
8+
- AGENTS.md exists for coding agents.
9+
- Copilot instructions exist.
10+
- Governance, support, security, versioning, changelog, and conduct files exist.
11+
- Templates are usable without empty placeholder values.
12+
- Wiki source pages exist.
13+
- CI validates required structure.
14+
15+
## Documentation quality
16+
17+
- Every Markdown file starts with a title.
18+
- Key methodology docs include Mermaid diagrams.
19+
- Relative links resolve.
20+
- Public pages explain what AI-OS is and how to use it.
21+
- The docs distinguish canonical repository docs from wiki mirrors.
22+
23+
## Engineering quality
24+
25+
- Loops exist for feature, bugfix, refactoring, pipeline repair, infrastructure, security, performance, and release.
26+
- Verifier gates exist.
27+
- Continuous improvement loop exists.
28+
- Evaluation framework exists.
29+
- Local runner concept exists.
30+
31+
## Release readiness
32+
33+
- Versioning policy exists.
34+
- Release workflow exists.
35+
- Changelog exists.
36+
- Human review remains part of the release process.

0 commit comments

Comments
 (0)