Skip to content

Docs: rewrite the public home and getting-started flow#122

Merged
nerdchanii merged 1 commit into
mainfrom
codex/issue-117-home-getting-started
May 28, 2026
Merged

Docs: rewrite the public home and getting-started flow#122
nerdchanii merged 1 commit into
mainfrom
codex/issue-117-home-getting-started

Conversation

@nerdchanii

Copy link
Copy Markdown
Owner

Summary

  • rewrite the public docs home page as a user-facing landing page
  • add install guidance and a minimal provider-based React usage path near the top
  • point readers to the guide, examples, API, Next.js, compatibility, and migration pages in a natural order

Type

  • API
  • Runtime
  • Testing
  • Docs
  • Tooling
  • Packaging/release

Priority

  • P0 - Critical
  • P1 - High
  • P2 - Medium
  • P3 - Low
  • P4 - Backlog

Verification

  • Tests added or updated
  • Typecheck passes
  • Build passes
  • Docs/examples updated if needed

Release Intent

  • Changeset added
  • No release needed (docs/project-only or tooling-only and does not affect consumers)

Notes

Related issue: Closes #117

Verification:

  • npm run docs:build
  • npm run lint

@nerdchanii

Copy link
Copy Markdown
Owner Author

@codex review

Context:

@nerdchanii nerdchanii marked this pull request as ready for review May 28, 2026 20:27
@nerdchanii nerdchanii merged commit a93095a into main May 28, 2026
2 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c39c081343

ℹ️ 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".

Comment thread docs/public/index.md
const [messages, sendTalk] = useSocket<ChatSchema, "talk">("talk");

return (
<button type="button" onClick={() => sendTalk("hello")}>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Disable sending until the WebSocket is open

When this getting-started snippet is copied against a real endpoint, ChatMessages renders as soon as the SocketStore is constructed, so the button can be clicked while the WebSocket is still CONNECTING or after the placeholder endpoint fails. useSocket forwards the click directly to store.send, and the core socket-store send contract throws ERR_SOCKET_NOT_OPEN unless readyState === 1, so the first click can crash the example; gate the button/rendering on an open/onConnect state or otherwise handle the not-open case.

Useful? React with 👍 / 👎.

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.

Docs: Rewrite public home and getting started flow

1 participant