Skip to content

Commit 63f1dbf

Browse files
committed
docs: harden Mermaid diagrams for GitHub
Replace Mermaid blocks with punctuation-free quoted labels and remove subgraphs to avoid GitHub renderer parse errors. Made-with: Cursor
1 parent c984dfc commit 63f1dbf

2 files changed

Lines changed: 8 additions & 32 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ If you want the shortest summary: **Cursor/Copilot help you ask; ctxeng helps yo
5252

5353
```mermaid
5454
flowchart LR
55-
U[You / task] --> C[ctxeng]
56-
R[(Your repo)] --> C
57-
C --> O[LLM-ready context (XML, Markdown, plain)]
58-
O --> A[LLM (ChatGPT/Claude/Gemini/API)]
59-
A --> B[Better answers, less hallucination]
55+
U["You and your task"] --> C["ctxeng"]
56+
R["Your repo"] --> C
57+
C --> O["LLM ready context"]
58+
O --> A["LLM"]
59+
A --> B["Better answers"]
6060
```
6161

6262
Docs:

docs/ARCHITECTURE.md

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,9 @@
44

55
```mermaid
66
flowchart TD
7-
subgraph Inputs
8-
Q[Task / query]
9-
R[(Repository root)]
10-
O[Options / flags]
11-
end
12-
13-
subgraph Pipeline
14-
D[Discover files]
15-
S[Score + rank]
16-
IG[Import-graph expansion (optional)]
17-
RAG[RAG chunk retrieval (optional)]
18-
SK[AST skeleton (optional)]
19-
RX[Redact secrets + PII (optional, default on)]
20-
B[Fit token budget]
21-
RND[Render output (XML, Markdown, plain)]
22-
end
23-
24-
Q --> S
25-
R --> D --> S --> IG --> RAG --> SK --> RX --> B --> RND
26-
O --> D
27-
O --> S
28-
O --> IG
29-
O --> RAG
30-
O --> SK
31-
O --> RX
32-
O --> B
33-
RND --> OUT[Context output + metadata]
7+
Q["Task query"] --> S["Score and rank"]
8+
R["Repo root"] --> D["Discover files"] --> S --> IG["Import graph optional"] --> RAG["RAG optional"] --> SK["Skeleton optional"] --> RX["Redact optional"] --> B["Fit token budget"] --> RND["Render output"]
9+
RND --> OUT["Context output"]
3410
```
3511

3612
## Key design goals

0 commit comments

Comments
 (0)