Skip to content

docs(readme): replace mermaid hero diagram with ASCII boxes; refresh project layout - #12

Merged
peterajhgraham merged 1 commit into
mainfrom
claude/festive-turing-IYzWG
May 23, 2026
Merged

peterajhgraham merged 1 commit into
mainfrom
claude/festive-turing-IYzWG

Conversation

@peterajhgraham

Copy link
Copy Markdown
Owner

Summary

  • Replaces the Quick Visual mermaid diagram at the top of the README with an ASCII box diagram that matches the existing Architecture section style (all written form, no rendered image).
  • Refreshes the Project Layout tree to reflect the actual repo: cortex/{models,kernels,quantization,training,data,serve,cache,utils}, plus ops/{docker,dashboards,helm,k6}, docs/, BENCHMARKS.md, ROADMAP.md, Makefile, and the real scripts/, tests/, and benchmarks/ contents.

Test plan

  • Render README on GitHub and confirm the top diagram is plain text and the layout matches the actual tree.

Generated by Claude Code

…project layout

Match the box-style diagram already used in the Architecture section, and
update the Project Layout tree to reflect the actual cortex/ subpackages,
ops/, docs/, and top-level files.
@peterajhgraham
peterajhgraham marked this pull request as ready for review May 23, 2026 19:28
@peterajhgraham
peterajhgraham merged commit 8ef1fe1 into main May 23, 2026
4 checks passed
@peterajhgraham
peterajhgraham deleted the claude/festive-turing-IYzWG branch May 23, 2026 19:28
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.

2 participants