Skip to content

docs: reframe Code and Evidence as built-in features, add engine badges - #413

Merged
solomonneas merged 1 commit into
mainfrom
docs/engines-reframe-remainder
Jul 21, 2026
Merged

docs: reframe Code and Evidence as built-in features, add engine badges#413
solomonneas merged 1 commit into
mainfrom
docs/engines-reframe-remainder

Conversation

@solomonneas

Copy link
Copy Markdown
Collaborator

What

Continues the "engines, not sidecars" reframe (after #409 and #410). Those PRs moved GraphTrail and MiseLedger under engines/ and stopped calling them sidecar stations. This one goes a step further per maintainer direction: the product names themselves confuse readers, so lead with what the features do.

  • Tagline, hub paragraph, component table: lead with Code (a code-intelligence graph) and Evidence (a receipt and memory ledger). Old names kept as an inline (formerly GraphTrail) / (formerly MiseLedger) on first mention.
  • Hub marks + table now link to the capability pages (/code-intelligence, /evidence-memory) instead of the old product URLs (which redirect).
  • Cross-model-runs bullet: the stray GraphTrail reference becomes plain code-graph.
  • ROADMAP glossary: drop evidence and search from the "optional sidecar station" examples (they are engines now), and add a one-line note that the Code and Evidence engines are not stations.
  • Badges: add Rust (the Code engine, engines/code-graph) and Go (the Evidence engine, engines/evidence-ledger) alongside Python. The repo now ships both.

Not touched

  • graph-delta.json "sidecar" file mechanics, sidecar_path, and the process-boundary binary docstrings: those are accurate mechanics, not product framing.
  • docs/wiring-graphtrail-miseledger.md: pure wiring mechanics using the real graphtrail/miseledger binary names.
  • docs/station-contract.md: already handled by docs: finish engines-vs-stations reframe below the fold #410.

Verification

Copy-only change. Vale run on both changed files, gated on parity with the current accepted error count (README 19, ROADMAP 7); no new violations introduced. Companion brigade-site work replaces the two product pages with the Code Intelligence / Evidence Memory capability pages and keeps the old URLs as redirects.

Co-authored-by: Claude noreply@anthropic.com

The names GraphTrail and MiseLedger read as separate products even after
#409/#410 moved them under engines/. Lead with what they do instead: Code
(a code-intelligence graph) and Evidence (a receipt and memory ledger),
with the old names kept as an inline "(formerly ...)" parenthetical on
first mention. Point the hub marks and component table at the capability
pages, plain-language the one stray "GraphTrail" in the cross-model-runs
bullet, and drop the two engines out of the ROADMAP station glossary since
they are not stations.

Add Rust and Go badges: the Code engine (engines/code-graph) is Rust and
the Evidence engine (engines/evidence-ledger) is Go, both now shipping in
this repository.

Co-authored-by: Claude <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are limited based on label configuration.

🏷️ Required labels (at least one) (1)
  • coderabbit-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository: escoffier-labs/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 137428c3-4ffd-4d06-ab89-cdca2fb5718a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/engines-reframe-remainder

Comment @coderabbitai help to get the list of available commands.

@solomonneas solomonneas self-assigned this Jul 21, 2026
@solomonneas
solomonneas merged commit f588957 into main Jul 21, 2026
26 checks passed
@solomonneas
solomonneas deleted the docs/engines-reframe-remainder branch July 26, 2026 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant