Skip to content

beautify README: hero SVG, loop diagram, restructured content#383

Merged
azalio merged 1 commit into
mainfrom
feat/readme-beautify
Jul 23, 2026
Merged

beautify README: hero SVG, loop diagram, restructured content#383
azalio merged 1 commit into
mainfrom
feat/readme-beautify

Conversation

@azalio

@azalio azalio commented Jul 23, 2026

Copy link
Copy Markdown
Owner

Redesign README with native SVG visual system:

  • hero.svg: title block with approval-gate motif (PLAN highlighted, LEARN→next run loop)
  • loop.svg: before/after comparison — idea→prompt→code→hope vs SPEC→PLAN→TEST→CODE→REVIEW→LEARN
  • section-quickstart.svg: numbered section header with navigation cue

Content restructured: proof before claims, case study (90→7 days) promoted, under-hood details collapsed into <details>, duplicative text removed.

Art direction: terminal theme (#0E1116), amber accent (#F0B429) for PLAN gate, green (#3FB950) for LEARN/loop, system sans + ui-monospace.

Summary by CodeRabbit

  • Documentation
    • Reworked the README’s introduction, hero section, and “Why MAP Exists” content.
    • Updated Quick Start instructions for initialization and Codex hook setup.
    • Refined guidance for the golden path, case studies, use cases, and core commands.
    • Expanded workflow details covering calibration, safety boundaries, context handling, retries, token reporting, and run health.
    • Updated option descriptions, autonomy guidance, success criteria, and troubleshooting instructions.

- New SVG assets: hero (approval-gate motif), before/after loop diagram, section header
- README restructured: proof before claims, case study higher, under-hood collapsed
- Removed duplicative blockquotes and internal implementation detail
- Art direction: terminal theme, #0E1116 bg, amber accent for PLAN gate, green for LEARN/loop
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c932e6df-377d-4319-822c-2927cbe2888f

📥 Commits

Reviewing files that changed from the base of the PR and between 36feab0 and d794eb2.

⛔ Files ignored due to path filters (3)
  • assets/readme/hero.svg is excluded by !**/*.svg
  • assets/readme/loop.svg is excluded by !**/*.svg
  • assets/readme/section-quickstart.svg is excluded by !**/*.svg
📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md was reorganized with a new introduction, updated Codex setup instructions, revised command and workflow documentation, expanded implementation details, clarified policy behavior, and refreshed troubleshooting guidance.

Changes

README documentation refresh

Layer / File(s) Summary
Onboarding and command guidance
README.md
Introduces a new hero and “Why MAP Exists” section, updates Codex initialization and hook instructions, and revises workflow, case study, usage, and core command content.
Workflow and option descriptions
README.md
Refreshes workflow roles, success criteria, engineering details, minimality doctrine, and context-compression behavior.
Safety and troubleshooting guidance
README.md
Documents safety-guardrails.py enforcement for commit/push denial and updates troubleshooting bullet formatting.
Estimated code review effort: 1 (Trivial) ~5 minutes

Possibly related PRs

  • azalio/map-framework#65: Related README updates covering Quick Start, workflow, commands, and architecture documentation.

Poem

A rabbit hops through MAP’s new guide,
With clearer paths from side to side.
Hooks stand guard and commands gleam,
Context packs neatly for the dream.
“Quick Start!” I thump—then bound with pride.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/readme-beautify

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@azalio
azalio merged commit 7882132 into main Jul 23, 2026
6 of 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.

1 participant