Use this index to find the right documentation by reader profile or goal. For installation and first use, start with the repository README, then follow one of the paths below.
Chinese index: README.zh-CN.md
| Reader or goal | Start here | Continue with |
|---|---|---|
| New user | Repository README | Cold-install checklist |
| Contributor | Product specification | Architecture -> Roadmap |
| v0.3/v0.4 planning and W4 status | Roadmap | W4 design -> ADR-003 -> ADR-001 / ADR-002 |
| Knowledge-base maintainer | Knowledge-base build guide | Manual MCP registration |
| Evaluation work | Automated evaluation workflow | Runtime evaluation design |
| Automatic session collection | Automated evaluation workflow | Capture package schema |
| Architecture or design review | Architecture | Design decisions and research |
| Project change review design | W4 design | ADR-003 and Roadmap |
This index covers product, engineering, operations, and historical documentation.
The README.md files under mcp/, kb_local/, and kb_minimal/ describe only
the components or resources in their respective directories; they do not replace
this index or the repository README.
The released v0.3.0 W4 review and gated handoff provide:
review_project_changes to inspect a selected .psfm folder against a Git
baseline, then use commit_project_changes and push_project_commit only
after their separate confirmations. Recognized model artifacts are selected
by default, repository-outside paths are always excluded, and suspicious
in-model paths require an explicit decision. The released Python package is
0.3.0; branch, revert, force-push, and .psfm write-back operations are not
enabled.
These guides cover installation, configuration, and maintenance of the local knowledge base and MCP integration:
- Automated evaluation workflow
- Task admission protocol
- Capture package schema
- Runtime evaluation design
- Archived and manual fallback evaluation documents
This section documents reproducible evaluation contracts and metrics. Private run files and generated evaluation artifacts remain outside the public source tree.
- ADR-001: Optional hybrid retrieval pilot
- ADR-002: Evaluation framework and explicit local feedback
- ADR-003: Project change review and Git handoff
Research documents distinguish verified public evidence from project interpretation and should not be treated as product specifications.