Revamp README: re-frame intro, simplify sections, add visual polish#48
Merged
Conversation
Re-order the intro emphasis to lead with AI-agent coding, automation, and the human-in-the-loop gates; then context economy; then engineering best practices, with documentation de-emphasized to a closing mention. Simplify How it works (10 steps → 7), Quick start (guided flow leads), Questions, and Status. Add a hero banner reference (doc/assets/banner.png), an expanded badge row, and tasteful heading emojis. Record the pass as a checked Phase 12 roadmap item (does not reopen the completed README rewrite). README-only change plus the roadmap edit; no process-doc/template counterpart. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…eview.png The hero banner is doc/assets/cdd-social-preview.png (reused as the social preview), not a separate banner.png. Update the README reference and its alt text (green wordmark, orange period) and the roadmap path mention. Also commit the refreshed task-cycle diagram. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The task-cycle diagram now places the human gates down the left side, not across the top; fix the "How it works" prose and image alt text to match. Rename doc/assets/cdd-social-preview.png -> social-preview.png so the filename no longer trips the prompt-seam check as a phantom /cdd-* command; update the README banner reference and the roadmap annotation. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
… title emojis Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refreshes the README for the open-source rollout — a re-framing and visual-polish pass on top of the earlier from-scratch rewrite (roadmap item ticked, not a reopen).
What changed
doc/assets/social-preview.png), an expanded badge row (License, Built with Claude Code, Issues welcome, status — alongside the existingtemplate-smokeCI badge), tasteful heading emojis, and a refreshedtask-cycle.png.README-only; no process-doc or template counterpart.
Pre-PR reconciliation (this branch)
task-cycle.pngplaces them down the left side — reconciled both.doc/assets/cdd-social-preview.png→social-preview.pngso the filename no longer trips the prompt-seam check as a phantom/cdd-*command; updated the banner reference and the roadmap annotation.Verification
Docs/image-only change, no test surface.
bash -n(all scripts),command-drift-check.sh, andprompt-seam-check.shall clean; no upstream drift.🤖 Generated with Claude Code