Give the README the shape aimock's has - #6
Merged
Conversation
A wall of prose asks a visitor to read before they can tell whether this is for them. Lead with one sentence, the diagram, and the badges that say it builds, then a table of surfaces and a scannable feature list. Two sections were saying the same thing three times over: a capability table, a feature list, and a components/MCP/skills section beneath both. Keep the feature list, drop the other two, and let docs/ carry the detail.
davidmckayv
requested review from
MikeRyanDev,
guidovizoso and
tylerslaton
as code owners
August 18, 2026 15:37
guidovizoso
approved these changes
Aug 18, 2026
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
2 participants
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.
Restructures
README.mdto follow CopilotKit/aimock: a centred header with a one-line pitch, a nav row, and CI / security / licence / alpha badges; the architecture diagram in the position aimock uses for its demo video; a short centred paragraph; then quick start, a table of surfaces, and a scannableFeatureslist.Also removes real duplication. The old README described components, MCP and skills in a reference section that the new
Featureslist already covers, and my first pass added a capability table that covered it a third time.Featuresstays, the other two go, anddocs/keeps the detail.Every claim in
Featuresis checked against the code rather than lifted from the old prose. Anchors and file links verified, format and lint clean.