Skip to content

websublime/unblock

Repository files navigation

://unblock — documentation

Documentation repository for ://unblock.
Reference project: arc-pm


Structure

docs/
├── MANIFESTO.md          ← Soul of the product: why, beliefs, immutable laws
├── PRD.md                ← Requirements: personas, market, phases, metrics
├── SPEC.md               ← Master technical specification (all systems)
├── plans/                ← Per-phase implementation plans (numbered)
│   ├── 01-plan-mcp-foundation.md
│   ├── 02-plan-mcp-complete.md
│   └── 03-plan-mcp-production.md
└── specs/                ← Per-component detailed specs (numbered)
    ├── 01-spec-graph-engine.md
    ├── 02-spec-github-client.md
    └── 03-spec-mcp-tools.md

Document hierarchy — abstract to concrete

Level Document Answers Tone
1 MANIFESTO Why do we exist? What do we believe? Philosophical, declarative, immutable
2 PRD What to build? For whom? In what order? Product, strategic — links to plans/specs
3 SPEC How does it work technically? Engineering, precise, all sections
4 plans/ How to implement each module? Epics, tasks, definition of done
5 specs/ What are the algorithms and edge cases? Validation, invariants, error catalogues

Patterns

  • MANIFESTO is the foundation — everything else is implementation detail
  • Cross-referencing — PRD header links to all plans and specs
  • Consistent numbering — plans and specs share the same number (01-plan-*01-spec-*)
  • Companion links — every document links to its related plan/spec
  • Plans have a fixed structure: Purpose → Rust Idioms → Public API Surface → Epics → Definition of Done

Source material

The docs/archive/ directory contains the original documentation written before this structure was adopted. Preserved for reference but superseded by the documents above.

License

Licensed under either of MIT or Apache-2.0 at your option.

About

AI issue tracker

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors