---
title: Docs map
description: Find design notes, reference documents and historical plans
tags: [reference]
status: published
category: appendix
---
# Docs map
Start with the [book introduction](README.md), [installation](getting-started/installation.md)
and [agent setup](getting-started/agent-setup.md). The book is the user-facing reference.
The source documents below preserve design rationale, research and implementation history.
Historical plans describe proposals at the time they were written, not guarantees of current behavior.
## Reference and research
- [PUBLISHING.md](https://github.com/scbrown/bobbin/blob/main/docs/PUBLISHING.md) — Publishing Bobbin.
- [architecture.md](https://github.com/scbrown/bobbin/blob/main/docs/architecture.md) — Bobbin Architecture.
- [commands.md](https://github.com/scbrown/bobbin/blob/main/docs/commands.md) — CLI Reference.
- [configuration.md](https://github.com/scbrown/bobbin/blob/main/docs/configuration.md) — Configuration.
- [crates-publishing.md](https://github.com/scbrown/bobbin/blob/main/docs/crates-publishing.md) — Publishing bobbin-ai to crates.io.
- [dev-log.md](https://github.com/scbrown/bobbin/blob/main/docs/dev-log.md) — **Historical** — Development Log.
- [paper-context-injection.md](https://github.com/scbrown/bobbin/blob/main/docs/paper-context-injection.md) — Decomposing Context Injection for AI Coding Agents.
- [primer.md](https://github.com/scbrown/bobbin/blob/main/docs/primer.md) — **Historical** — Bobbin Primer.
- [private-key-checks.md](https://github.com/scbrown/bobbin/blob/main/docs/private-key-checks.md) — Private-key checks.
- [roadmap.md](https://github.com/scbrown/bobbin/blob/main/docs/roadmap.md) — **Historical** — Roadmap.
## Calibration
- [calibration/round3-bobbin-bridge.json](https://github.com/scbrown/bobbin/blob/main/docs/calibration/round3-bobbin-bridge.json) — saved calibration result.
- [calibration/round3-bobbin-core.json](https://github.com/scbrown/bobbin/blob/main/docs/calibration/round3-bobbin-core.json) — saved calibration result.
- [calibration/round3-flask-bridge.json](https://github.com/scbrown/bobbin/blob/main/docs/calibration/round3-flask-bridge.json) — saved calibration result.
- [calibration/round3-flask-core.json](https://github.com/scbrown/bobbin/blob/main/docs/calibration/round3-flask-core.json) — saved calibration result.
- [calibration/round3-ruff-bridge.json](https://github.com/scbrown/bobbin/blob/main/docs/calibration/round3-ruff-bridge.json) — saved calibration result.
- [calibration/round3-ruff-core.json](https://github.com/scbrown/bobbin/blob/main/docs/calibration/round3-ruff-core.json) — saved calibration result.
## Design
- [design/knowledge-aware-bundles.md](https://github.com/scbrown/bobbin/blob/main/docs/design/knowledge-aware-bundles.md) — **Historical** — Knowledge-Aware Bundles: Code Entities in the Knowledge Graph.
- [design/micro-ui.md](https://github.com/scbrown/bobbin/blob/main/docs/design/micro-ui.md) — **Historical** — Bobbin Knowledge Integration: Embedding Quipu Web Components.
- [design/phase-4-features.md](https://github.com/scbrown/bobbin/blob/main/docs/design/phase-4-features.md) — **Historical** — Phase 4: Analysis & Intelligence Features.
- [design/role-based-filtering.md](https://github.com/scbrown/bobbin/blob/main/docs/design/role-based-filtering.md) — **Historical** — Bobbin Role-Based Repo Filtering (§69).
- [design/unified-search-v2.md](https://github.com/scbrown/bobbin/blob/main/docs/design/unified-search-v2.md) — **Historical** — Bobbin v2: Unified Search Engine.
## Designs
- [designs/bobbin-desirepath-integration.md](https://github.com/scbrown/bobbin/blob/main/docs/designs/bobbin-desirepath-integration.md) — **Historical** — Design: Bobbin Integration with Desire Path.
- [designs/bobbin-tags-annotations.md](https://github.com/scbrown/bobbin/blob/main/docs/designs/bobbin-tags-annotations.md) — **Historical** — Bobbin Tags & Annotations.
- [designs/context-bundles.md](https://github.com/scbrown/bobbin/blob/main/docs/designs/context-bundles.md) — **Historical** — Context Bundles: Stable, Addressable Knowledge Anchors for Bobbin.
- [designs/query-grouping.md](https://github.com/scbrown/bobbin/blob/main/docs/designs/query-grouping.md) — **Historical** — Parenthesised and Nested Boolean Query Grouping.
## Plans
- [plans/adaptive-defaults.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/adaptive-defaults.md) — **Historical** — Design: Adaptive Defaults — Project-Aware Search Configuration.
- [plans/advanced-query-syntax.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/advanced-query-syntax.md) — **Historical** — Advanced Query Syntax.
- [plans/backlog.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/backlog.md) — **Historical** — Bobbin Feature Backlog.
- [plans/beads-integration.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/beads-integration.md) — **Historical** — Bobbin + Beads Integration Plan.
- [plans/bobbin-debt.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/bobbin-debt.md) — **Historical** — Bobbin tech debt — measured.
- [plans/bobbin-roadmap.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/bobbin-roadmap.md) — **Historical** — Bobbin Roadmap — strategic direction.
- [plans/breadcrumb-system.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/breadcrumb-system.md) — **Historical** — Bobbin: Tool-Result Context + Breadcrumb System.
- [plans/calibration-sweep-results.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/calibration-sweep-results.md) — **Historical** — Calibration Sweep Results.
- [plans/documentation-strategy.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/documentation-strategy.md) — **Historical** — Plan: Comprehensive Documentation Strategy (bo-rd42).
- [plans/eval-charts-storage.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/eval-charts-storage.md) — **Historical** — Plan: Eval Results Preservation + evaluation charts.
- [plans/eval-framework.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/eval-framework.md) — **Historical** — Bobbin Eval Framework.
- [plans/eval-metrics-gate-tuning.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/eval-metrics-gate-tuning.md) — **Historical** — Eval Framework Improvements: Metrics, Gate Tuning & Agent Guidance.
- [plans/eval-results-mdbook.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/eval-results-mdbook.md) — **Historical** — Plan: Eval Results in mdbook + New Language Tasks.
- [plans/eval-tool-use-traces.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/eval-tool-use-traces.md) — **Historical** — Eval: Collect Claude Code Tool Use Traces via stream-json.
- [plans/file-classification-bridging.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/file-classification-bridging.md) — **Historical** — Plan: File Classification + Git Temporal Awareness (Line-Level Provenance).
- [plans/hooks-integration.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/hooks-integration.md) — **Historical** — Bobbin Hooks Integration Plan.
- [plans/injection-quality-assessment.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/injection-quality-assessment.md) — **Historical** — Injection Context Quality Assessment.
- [plans/native-metrics.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/native-metrics.md) — **Historical** — Plan: Bobbin Native Metrics & Eval Observability.
- [plans/paper-arxiv-submission.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/paper-arxiv-submission.md) — **Historical** — paper submission plan — bobbin-58.
- [plans/paper-measurement-validity.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/paper-measurement-validity.md) — **Historical** — Which paper measurements survive — bobbin-53.
- [plans/paper-statistics.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/paper-statistics.md) — **Historical** — Significance and power for the ablation arms — bobbin-55.
- [plans/ppr-ranking-signal.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/ppr-ranking-signal.md) — **Historical** — 🧠 Personalized PageRank Ranking Signal.
- [plans/production-hardening.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/production-hardening.md) — **Historical** — Bobbin Production Hardening Plan.
- [plans/quipu-integration.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/quipu-integration.md) — **Historical** — 🪢 Quipu Integration Plan.
- [plans/smart-dispatch-hooks.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/smart-dispatch-hooks.md) — **Historical** — Plan: Smart Dispatch — Tool-Aware Hook Responses.
- [plans/smart-hook-injection.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/smart-hook-injection.md) — **Historical** — Smart Hook Context Injection.
- [plans/tool-aware-context-reactions.md](https://github.com/scbrown/bobbin/blob/main/docs/plans/tool-aware-context-reactions.md) — **Historical** — Tool-Aware Context Reactions.
## Tasks
- [tasks/completions-1-clap-complete-dependency.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/completions-1-clap-complete-dependency.md) — **Historical** — Task: Add `clap_complete` dependency and completions subcommand.
- [tasks/completions-2-install-docs.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/completions-2-install-docs.md) — **Historical** — Task: Add shell completion installation documentation.
- [tasks/context-1-vectorstore-get-chunks.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/context-1-vectorstore-get-chunks.md) — **Historical** — Task: Add `get_chunks_for_file` to VectorStore.
- [tasks/context-2-assembler-module.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/context-2-assembler-module.md) — **Historical** — Task: Create Context Assembler Module.
- [tasks/context-3-cli-command.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/context-3-cli-command.md) — **Historical** — Task: Create CLI Command for `bobbin context`.
- [tasks/context-4-mcp-tool.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/context-4-mcp-tool.md) — **Historical** — Task: Add MCP `context` Tool.
- [tasks/deps-1-extraction.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/deps-1-extraction.md) — **Historical** — Task: Extract raw imports from tree-sitter AST.
- [tasks/deps-2-storage.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/deps-2-storage.md) — **Historical** — Task: Add dependencies table to MetadataStore.
- [tasks/deps-3-resolver.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/deps-3-resolver.md) — **Historical** — Task: Implement heuristic import resolver.
- [tasks/deps-4-index-integration.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/deps-4-index-integration.md) — **Historical** — Task: Integrate import extraction into the index pipeline.
- [tasks/deps-5-cli-integration.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/deps-5-cli-integration.md) — **Historical** — Task: Surface dependency graph in CLI commands.
- [tasks/hotspots-1-churn-batch.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/hotspots-1-churn-batch.md) — **Historical** — Task: Batch File Churn Method on GitAnalyzer.
- [tasks/hotspots-2-complexity-metrics.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/hotspots-2-complexity-metrics.md) — **Historical** — Task: AST Complexity Metrics Module.
- [tasks/hotspots-3-cli-mcp.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/hotspots-3-cli-mcp.md) — **Historical** — Task: `bobbin hotspots` CLI Command + MCP Tool.
- [tasks/impact-1-signal-merger.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/impact-1-signal-merger.md) — **Historical** — Task: Multi-Signal Impact Analysis Core.
- [tasks/impact-2-transitive.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/impact-2-transitive.md) — **Historical** — Task: Transitive Impact Expansion.
- [tasks/impact-3-cli-mcp.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/impact-3-cli-mcp.md) — **Historical** — Task: `bobbin impact` CLI Command + MCP Tool.
- [tasks/models-1-dynamic-dimensions.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/models-1-dynamic-dimensions.md) — **Historical** — Task: Make embedding dimensions dynamic.
- [tasks/models-2-expand-registry.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/models-2-expand-registry.md) — **Historical** — Task: Expand model registry and support custom models.
- [tasks/models-3-cli-model-management.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/models-3-cli-model-management.md) — **Historical** — Task: Add model management CLI commands.
- [tasks/publish-1-license-and-metadata.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/publish-1-license-and-metadata.md) — **Historical** — Task: Create LICENSE file and fix Cargo.toml metadata.
- [tasks/publish-2-exclude-patterns.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/publish-2-exclude-patterns.md) — **Historical** — Task: Add exclude patterns to Cargo.toml.
- [tasks/publish-3-ci-workflows.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/publish-3-ci-workflows.md) — **Historical** — Task: Add GitHub Actions CI and cargo publish workflow.
- [tasks/publish-4-dry-run-verification.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/publish-4-dry-run-verification.md) — **Historical** — Task: Verify cargo publish dry run.
- [tasks/readme-1-accuracy-update.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/readme-1-accuracy-update.md) — **Historical** — Task: Fix README accuracy - document all features and commands.
- [tasks/readme-2-sell-the-tool.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/readme-2-sell-the-tool.md) — **Historical** — Task: Make the README sell bobbin.
- [tasks/refs-1-fts-lookup.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/refs-1-fts-lookup.md) — **Historical** — Task: FTS-Based Symbol Reference Resolution.
- [tasks/refs-2-cli-mcp.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/refs-2-cli-mcp.md) — **Historical** — Task: `bobbin refs` CLI Command + MCP Tool.
- [tasks/refs-3-treesitter-upgrade.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/refs-3-treesitter-upgrade.md) — **Historical** — Task: Tree-Sitter Based Reference Accuracy Upgrade.
- [tasks/review-1-diff-parsing.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/review-1-diff-parsing.md) — **Historical** — Task: Git Diff Parsing on GitAnalyzer.
- [tasks/review-2-assembler-refactor.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/review-2-assembler-refactor.md) — **Historical** — Task: Refactor ContextAssembler to Accept External Seeds.
- [tasks/review-3-cli-mcp.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/review-3-cli-mcp.md) — **Historical** — Task: `bobbin review` CLI Command + MCP Tool.
- [tasks/similar-1-single-target.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/similar-1-single-target.md) — **Historical** — Task: Single-Target Similarity Search.
- [tasks/similar-2-scan-mode.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/similar-2-scan-mode.md) — **Historical** — Task: Scan Mode -- Codebase-Wide Duplicate Detection.
- [tasks/similar-3-cli-mcp.md](https://github.com/scbrown/bobbin/blob/main/docs/tasks/similar-3-cli-mcp.md) — **Historical** — Task: `bobbin similar` CLI Command + MCP Tool.