Skip to content

Refactor README layout#299

Merged
0xroylee merged 1 commit into
mainfrom
codex/reference-readme-layout
Jun 3, 2026
Merged

Refactor README layout#299
0xroylee merged 1 commit into
mainfrom
codex/reference-readme-layout

Conversation

@0xroylee

@0xroylee 0xroylee commented Jun 3, 2026

Copy link
Copy Markdown
Owner

What Changed

  • Reworked the root README.md into a product-first overview with a stronger opening pitch, fit/benefits section, problems-solved framing, under-the-hood architecture, quickstart, and docs navigation.
  • Updated packages/cli/README.md to keep the package README focused on CLI usage while aligning its opening with the root README and fixing related relative doc links.
  • Preserved the existing install/onboard/daemon flow and command references.

Why

  • The repo’s README needed a clearer top-level narrative that reads more like a product page and less like a command dump.
  • The CLI README and root README were overlapping in audience and needed a more consistent hierarchy.

How to Test

  • bun run typecheck passed.
  • bun test passed.
  • git diff --check on the touched README files passed.
  • README content scans confirmed ASCII-only text and correct relative links.
  • bun run check still fails because of unrelated Biome issues in packages/web/src/components/chat-room/chat-room-settings-sidebar.tsx and packages/web/src/components/chat-room/chat-room-sidebar.tsx.

Additional Notes

  • This change is documentation-only.
  • The repository-wide lint gate remains blocked by pre-existing web formatting/import-order issues outside the README scope.

@0xroylee 0xroylee changed the title Refactor README layout to match Paperclip-style product flow Refactor README layout Jun 3, 2026
@0xroylee 0xroylee merged commit f0dfd91 into main Jun 3, 2026
7 checks passed
@0xroylee 0xroylee deleted the codex/reference-readme-layout branch June 21, 2026 13:17
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