docs(readme): refactor to coder/coder header style + centered logo#33
Merged
Conversation
Restructures the README to follow the layout used by github.com/coder/coder: a centered header block with the project logo, an h1 tagline, a quick-jump nav row, and a row of badges — all inside `<div align="center">`. Adds docs/images/logo.svg as the canonical README logo (copied from the in-app icon at src/app/icon.svg so they stay visually aligned). Side-edits to bring the README in line with the post-DraftCard state: - Drops `intent_type` chip from the Features table (column removed in the DraftCard refactor — see commits ab627d5 + fa0b916 + be8e6bd on main). - Drops the deleted `/api/annotations/[id]/intent` endpoint from the agent-loop example. - Drops `intent.json` sidecar from the architecture filesystem tree. - Updates the test badge to the current 736/736 figure. - Updates the tech-stack list to reflect Radix Primitives + React 18 + client-side-only rendering, dropping the obsolete tldraw drawing layer and intent generator mentions. - Adds the inline DraftCard surface to the Features table.
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.
Summary
Refactors the README to follow the structure used by github.com/coder/coder:
<div align="center">— logo (128 px), h1 tagline, quick-jump nav (Quickstart · Install · Docs · Agent API · Architecture), and a tighter badge row.docs/images/logo.svg— new canonical README logo (copied fromsrc/app/icon.svgso the favicon and the README header stay visually aligned).Side-edits to bring the README in line with the post-DraftCard state (the agent-loop intent removal already shipped on
main):intent_typechip from the Features table./api/annotations/[id]/intentendpoint from the agent-loop example.intent.jsonsidecar from the architecture filesystem tree.Test plan
<div align="center">+<img width="">).docs/INDEX.md,docs/agent-loop/,docs/ci.md, etc.).