Skip to content

docs: comprehensive documentation overhaul#88

Closed
RtlZeroMemory wants to merge 1 commit into
mainfrom
docs/comprehensive-overhaul
Closed

docs: comprehensive documentation overhaul#88
RtlZeroMemory wants to merge 1 commit into
mainfrom
docs/comprehensive-overhaul

Conversation

@RtlZeroMemory

@RtlZeroMemory RtlZeroMemory commented Feb 19, 2026

Copy link
Copy Markdown
Owner

Summary

  • Comprehensive docs overhaul across backend, protocol, styling, widgets, and dev docs.
  • Corrected constants, defaults, type snippets, function signatures, and validation notes to match source.
  • Updated MkDocs navigation, overrides, styles, and added missing widget documentation pages.

Scope

  • Documentation-only changes (README.md, docs/**, mkdocs.yml, docs overrides/stylesheets).
  • No runtime/package source code changes under packages/**.

Review Focus

  • Information accuracy against current source contracts.
  • Navigation and cross-link structure.
  • Overall docs structure and readability.

@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: 4e7062c02c

ℹ️ 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/widgets/grid.md
```ts
ui.grid({ columns: "auto 1fr auto", gap: 1 }, [
ui.text("Label:"),
ui.input("name-input", { value: state.name, onChange: (v) => app.update({ name: v }) }),

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 Fix Input example to use supported callback signature

The Grid docs include ui.input("name-input", { value: state.name, onChange: ... }), but ui.input only accepts (id, value, props?) or a single InputProps object, and InputProps uses onInput (not onChange) (packages/core/src/widgets/ui.ts and packages/core/src/widgets/types.ts). As written, this example fails type-checking and, if copied into untyped code, passes a non-string value that triggers runtime prop validation errors, so readers following this snippet will hit a broken integration path immediately.

Useful? React with 👍 / 👎.

@RtlZeroMemory
RtlZeroMemory deleted the docs/comprehensive-overhaul branch February 19, 2026 17:45
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