Skip to content

README: trim to the essentials - #279

Merged
patrickchugh merged 2 commits into
mainfrom
docs/readme-trim
Oct 23, 2026
Merged

patrickchugh merged 2 commits into
mainfrom
docs/readme-trim

Conversation

@patrickchugh

Copy link
Copy Markdown
Owner

Trims the README from 497 to 290 lines now that terravision.online carries the friendly introduction. Stacked on #278 (the terravision.online link); merge that first.

Kept

  • Pitch, badges, video, gallery grid, draw-prod callout
  • Per-OS prerequisites and assistant setup (constitution AI-001 requires nothing-to-diagram in the README)
  • Ask table, CI/CD, Why, comparison table, provider counts table (tests/test_type_counts.py), #install anchor (printed by the CLI), demos

Moved behind links to pages that already cover them

  • No-package-manager paragraph → installation guide
  • Skills CLI and Gemini CLI notes → ai-assistants guide
  • Azure/GCP JSON examples → graph-format.md
  • Advanced Usage (draw-prod detail, pre-generated plan, AI annotations, simplified view, options table) → usage guide and draw-any-environment page
  • Why list condensed from 13 bullets to 7; docs links, contributing, support, licence and acknowledgments merged into two short sections

Generated by Claude Code

chughpatrick-arch and others added 2 commits October 23, 2026 07:25
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015W9FYjiEKrbLthx1Y57Ayu
…site

497 to 290 lines. Keeps the per-OS prerequisites and assistant setup
(constitution AI-001), the ask table, CI/CD, why, comparison table,
provider counts (tests/test_type_counts.py), the #install anchor the CLI
prints, and the demos. Moves advanced CLI usage, the options table, the
Azure/GCP JSON examples, the long draw-prod section and the no-package-
manager paragraph behind links to the pages that already cover them.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015W9FYjiEKrbLthx1Y57Ayu
@patrickchugh
patrickchugh merged commit 849bf43 into main Oct 23, 2026
7 checks passed
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