Skip to content

Docs: rewrite the examples page around user scenarios#123

Merged
nerdchanii merged 1 commit into
mainfrom
codex/issue-118-user-scenario-examples
May 28, 2026
Merged

Docs: rewrite the examples page around user scenarios#123
nerdchanii merged 1 commit into
mainfrom
codex/issue-118-user-scenario-examples

Conversation

@nerdchanii

Copy link
Copy Markdown
Owner

Summary

  • replace maintainer-oriented examples framing with user-facing scenario sections
  • keep the Local Vite, React Router loader, and Next.js App Router examples while clarifying when to use each one
  • remove docs-maintenance wording and copy-paste safety columns from the public examples page

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 #118

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:29
@nerdchanii nerdchanii merged commit b0c428c 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: 1a53bc493d

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

Choose the example that matches how your app owns the realtime store.

## Canonical Examples Index
## Local Vite App

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 Preserve the provider example anchor

Renaming this heading changes the generated docs fragment from #local-vite-provider-example to #local-vite-app, but docs/agents/agent-context.json still points the provider-backed React app example at docs/public/examples/index.md#local-vite-provider-example. Agents or tooling that follow that metadata now land on a missing/incorrect section, so either keep an explicit old anchor or update the metadata alongside this rename.

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 examples page for user scenarios

1 participant