Skip to content

docs(readme): redraw the front half for newcomers after 1.0 - #478

Merged
MendixMau merged 2 commits into
masterfrom
docs/readme-refresh-after-1.0
Oct 20, 2026
Merged

MendixMau merged 2 commits into
masterfrom
docs/readme-refresh-after-1.0

Conversation

@MendixMau

Copy link
Copy Markdown
Owner

The README front half was text-heavy and predated most of 1.0. This redraws it for someone landing on the repo for the first time. Reference and the generated routing blocks are untouched.

  • Diagram of where the toolkit sits (you, the agent, toolkit, mxcli, the app, reports)
  • The measured 1.0 numbers: 5 of 5 vs 0 of 5 bad-binding refusals, ~40% fewer tool calls with context packs, 0 to 1 of 20 journeys per change
  • The pipeline as three phases (Understand, Design, Build and ship) with the hard gates
  • A pieces table and a new What you see table: process map and BRD report, progress report, dashboard, bug log
  • Short sections for modes, quick start, settings (links the 1.0 settings table), testing, input, bundled releases
  • The earlier detail is kept behind <details> folds, nothing removed

Reader-visible words above Reference: about 1,900 → about 530. Rendered and checked locally with GitHub's markdown API plus Mermaid.

Impact

Always-loaded text none
Routed skills none
Scripts none
Sync behaviour none
Consumer action none

render-routing --check, check-skill-routing, tests/run-tests.sh (33/33), PR discipline and the leak guard pass.

🤖 Generated with Claude Code

MendixMau and others added 2 commits October 21, 2026 00:26
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…me from

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@MendixMau
MendixMau force-pushed the docs/readme-refresh-after-1.0 branch from 41def89 to ebdc949 Compare October 20, 2026 17:26
@MendixMau
MendixMau merged commit 4922a3a into master Oct 20, 2026
2 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