Skip to content

docs(readme): move OpenTUI component docs into dedicated page#186

Open
benvinegar wants to merge 2 commits intomainfrom
docs/opentui-component-docs
Open

docs(readme): move OpenTUI component docs into dedicated page#186
benvinegar wants to merge 2 commits intomainfrom
docs/opentui-component-docs

Conversation

@benvinegar
Copy link
Copy Markdown
Member

Summary

  • move the exported OpenTUI component docs out of the top-level README into docs/opentui-component.md
  • keep the README section minimal and link to the dedicated component doc
  • add a cross-link from the component example README back to the new docs page

Testing

  • not run (docs-only change)

This PR description was generated by Pi using OpenAI o3

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 9, 2026

Greptile Summary

This PR refactors the OpenTUI component documentation out of the top-level README.md into a dedicated docs/opentui-component.md page, and adds a cross-link from the component examples README. The new doc page is more thorough than what it replaces — it adds peer dependency install instructions, a fuller quick-start snippet (including renderer setup), default values in the props table, and a complete list of named exports.

Confidence Score: 5/5

Docs-only reorganization with no code changes; safe to merge.

All changes are documentation. The new page is more complete than what it replaces, all relative links are structurally correct, and no code paths are affected.

No files require special attention.

Vulnerabilities

No security concerns identified.

Important Files Changed

Filename Overview
docs/opentui-component.md New dedicated docs page; more complete than the original README section — adds peer dep install, renderer setup, props table with defaults, and full export list.
README.md Replaced verbose inline component docs with a one-liner and link to the new dedicated page; overall README is cleaner.
examples/7-opentui-component/README.md Adds a single cross-link to the new docs page; relative path is correct.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.md] -->|"links to"| B[docs/opentui-component.md]
    B -->|"links to"| C[examples/README.md]
    B -->|"links to"| D[examples/7-opentui-component/README.md]
    D -->|"cross-link back to"| B
Loading

Reviews (1): Last reviewed commit: "docs(readme): move OpenTUI component doc..." | Re-trigger Greptile

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