Repository navigation
docs: document the repository graph and project memory - #26
Merged
Merged
Conversation
Adds documentation for the 0.4 repository graph release. New pages: - Repository graph: enablement (opt-in, not scaffolded by `ferrus init`), incremental indexing, the three built-in extractors with their node and edge kinds, the full `ferrus graph` command surface, orthogonal availability/build/freshness reporting, task worktree views, the read-only MCP tools and verified snippets, privacy invariants, query budgets, and the recorded benchmark and evaluation results. - Project memory: the default source allowlist and what is never indexed, `ferrus graph memory` commands, `--domain` federation semantics, repository link resolution states, and archive-driven refresh. Updates: - Configuration: `[repository_graph]` namespace reference, including which settings participate in snapshot identity, plus the two new sidecars in the runtime file table. - Quickstart: optional indexing step. - Supported agents: the six read-only retrieval tools exposed to every role. - State machine: pinned per-task repository views. - Specs & Milestones: how an approved `## Outcome` feeds project memory. - Sidebar, navbar, and footer entries; homepage section, feature cards, and version bump to 0.4.0-alpha.1. Command output and fact/edge vocabulary in the examples were captured from ferrus 0.4.0-alpha.1 running against the ferrus repository. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
ferrus | 203e9b9 | Commit Preview URL Branch Preview URL |
Aug 31 2026, 03:06 PM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation for the 0.4 repository graph release.
New pages
Repository graph (
/docs/repository-graph) — the flagship page:[repository_graph]namespace is not scaffolded byferrus init)--full, and where the sidecar livesferrus graph status|search|show|context|neighborssurface with real command outputProject memory (
/docs/project-memory):ferrus graph memory index|status--domain repository|memory|alland what federation does not doresolved/stale/unresolved)Updates to existing pages
[repository_graph]reference with a per-namespace "affects snapshot identity" column;source,index_limits,query_limits,retention,telemetrydefaults; the two new sidecars in the runtime file table## Outcomefeeds project memoryPlus a
Repository intelligencesidebar category, navbar and footer entries, a homepage section, two new feature cards, and the version bump to 0.4.0-alpha.1.Verification
npm run buildpasses clean — no broken links (onBrokenLinks: 'throw') and no broken anchors.Command output, node/edge vocabulary, semantic key formats, config defaults, MCP tool names, and input schemas in the examples were all read from the source or captured from
ferrus 0.4.0-alpha.1running against the ferrus repository, rather than paraphrased from the design docs.Note
ferrus/docs/milestones.mdstill lists the repository graph and project memory as "not started". That is a separate repository and is already planned.🤖 Generated with Claude Code