Repository navigation
docs: rewrite README landing page and add CONTRIBUTING.md - #81
Conversation
Replace the single ~100-word intro sentence with a two-sentence pitch and three bullets, trim the feature list to one line per item, shorten the documentation section to entry points into docs/README.md, merge the Vercel relationship and non-goals into one Scope section, drop the hardcoded release number (the badge shows it), and link a new CONTRIBUTING.md covering setup, repository layout, mise tasks, the documentation tests, and ADR expectations. The hello-world program is unchanged and still compile-checked; the pinned "not a TypeScript API port" phrase is kept. _Generated with [`xum`](https://github.com/coder/xum) • Model: `anthropic:claude-opus-5-5` • Thinking: `high`_
|
@codex review |
|
@codex security review |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Moves the Linear example's maintainer-only dogfooding checklist into contributor docs (removed from the example README in #82). _Generated with [`xum`](https://github.com/coder/xum) • Model: `anthropic:claude-opus-5-5` • Thinking: `high`_
🛡️ Codex Security ReviewSecurity review completed. No security issues were found in this pull request. Reviewed commit: Only the user who started this review can view the report in Codex. ℹ️ About Codex security reviews in GitHubThis is an experimental Codex feature. Security reviews are triggered when:
Once complete, Codex will leave suggestions, or a comment if no findings are found. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2c5f7ef148
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Mark deferred dispatch as opt-in on the landing page, add mise trust to setup, and show GOFLAGS=-race only on the CI test command. _Generated with [`xum`](https://github.com/coder/xum) • Model: `anthropic:claude-opus-5-5` • Thinking: `high`_
|
@codex review |
|
@codex security review |
|
Codex Review: Didn't find any major issues. 🎉 Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
🛡️ Codex Security ReviewSecurity review completed. No security issues were found in this pull request. Reviewed commit: Only the user who started this review can view the report in Codex. ℹ️ About Codex security reviews in GitHubThis is an experimental Codex feature. Security reviews are triggered when:
Once complete, Codex will leave suggestions, or a comment if no findings are found. |
_Generated with [`xum`](https://github.com/coder/xum) • Model: `anthropic:claude-opus-5-5` • Thinking: `high`_
|
@codex review |
|
@codex security review |
|
Rendered-docs evidence (GitHub preview of the branch; documentation check only, not a live Slack/Linear run). Captured at head
The attached video is a compressed agent-browser tour (README → CONTRIBUTING → #82 example README and tutorial Step 5 → #80 Linear how-to). Generated with tour.mp4 |
|
Codex Review: Didn't find any major issues. Delightful! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
🛡️ Codex Security ReviewSecurity review completed. No security issues were found in this pull request. Reviewed commit: Only the user who started this review can view the report in Codex. ℹ️ About Codex security reviews in GitHubThis is an experimental Codex feature. Security reviews are triggered when:
Once complete, Codex will leave suggestions, or a comment if no findings are found. |
1 participant
Rewrites the README landing page for scannability and adds contributor docs. PR 2 of a docs cleanup (PR 1: #80). Independent of #80; no shared files.
README
docs/README.mdCONTRIBUTING.mdUnchanged: badges, the compile-checked hello-world program, Install, and the adapter tier table (wording tightened). The pinned phrase "not a TypeScript API port" is kept for
documentation_test.go.CONTRIBUTING.md (new)
Setup (mise, Docker for Testcontainers), module layout and
go.work, the CI commands (mise run vet,mise run testwith-race) plus narrower tasks, the examplego mod tidyrule for state-module bumps, whatdocumentation_test.gochecks, a live-validation checklist (moved from the Linear example README in #82), and ADR expectations. Linked from the README and fromdocs/README.md.Not included
Validation
go test -run 'Documentation|README|Snippets' .passes (README hello-world still builds; pinned phrases present).git diff --checkclean.Generated with
xum• Model:anthropic:claude-opus-5-5• Thinking:high