add mermaid diagrams across docs for visual onboarding#28
Merged
Conversation
Give readers scannable flowcharts in the README, usage guide, architecture pages, and testing docs, plus a conventions guide so future diagrams stay consistent. Co-authored-by: Cursor <cursoragent@cursor.com>
This reverts commit 25411d5.
One system map shows SQLite cache vs sidecar lanes and which commands each gate. Usage adds a scannable readiness table. Sidecar ops adds localhost topology only. Co-authored-by: Cursor <cursoragent@cursor.com>
Replace the Public Promise wall with a user-facing why section, put the diagram right under it, and tuck caveats into Evidence and claims. Co-authored-by: Cursor <cursoragent@cursor.com>
Explain index, embed, search, trail, and answer steps with a diagram and short paragraphs before the system map. Co-authored-by: Cursor <cursoragent@cursor.com>
Replace command flowcharts and spec-table bottom with specific indexing/search/trail/embed prose, one sequence diagram, a short get-started block, and a docs link list. Co-authored-by: Cursor <cursoragent@cursor.com>
Undo the experimental readme rewrites; the original structure and reference sections were more useful. Co-authored-by: Cursor <cursoragent@cursor.com>
Replace duplicate diagrams and spec prose with numbered workflow steps, one evidence-flow diagram, a short try-it block, and a compact reference footer. Update onboarding contract tests. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
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
1 participant
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.
Summary
docs/contributors/documentation-visuals.mdwith diagram conventions, canonical diagram index, and a no-benchmark-numbers-in-diagrams rule.AGENTS.md.Test plan
docs/usage.mdanddocs/ops/retrieval-sidecars.mddiagrams in GitHub preview.cargo test -p codestory-cli --test onboarding_contracts