Feature Map
Index combines human-readable documentation with machine-readable structure so repository intelligence can survive handoffs, audits, and agent sessions.
| Surface | What it does | Start here |
|---|---|---|
| Management contract | Defines ownership, approved content roots, registries, lifecycle, and enabled interfaces. | index.json |
| Documentation | Provides VitePress pages, local search, and LLM-readable exports. | docs/index.md |
| Repository registry | Tracks repositories with ownership, purpose, status, tags, and start-here files. | repos/index.yaml |
| Workspace metadata | Captures clients, projects, contacts, communications, next actions, and evidence. | schemas/workspace.schema.json |
| Validation | Checks the index contract, workspace records, references, dates, enums, and suspicious secret-like keys. | scripts/validate-index.mjs, scripts/validate-workspaces.mjs |
| MCP server | Exposes approved docs and repository entries as read-only resources and search tools. | mcp/src/ |
| Slack mentions | Applies a deny-by-default channel policy to the same read-only search service. | docs/slack.md, slack/access-policy.json |
| Prompt library | Provides investigation, build, rescue, and handoff prompts. | prompts/core-prompts.md |
| Project hygiene | Provides contribution guidance, CI validation, and repeatable checks. | CONTRIBUTING.md, .github/, Makefile |
Operating Model
- Keep credentials and local state out of source control.
- Record confirmed facts separately from assumptions and open questions.
- Cite repository-relative evidence paths.
- Validate changes before humans or agents rely on them.
- Keep MCP and Slack behavior read-only unless a separate reviewed capability explicitly requires mutation.