docs(readme): move OpenTUI component docs into dedicated page#186
docs(readme): move OpenTUI component docs into dedicated page#186benvinegar wants to merge 2 commits intomainfrom
Conversation
Greptile SummaryThis PR refactors the OpenTUI component documentation out of the top-level Confidence Score: 5/5Docs-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.
|
| 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
Reviews (1): Last reviewed commit: "docs(readme): move OpenTUI component doc..." | Re-trigger Greptile
Summary
docs/opentui-component.mdTesting
This PR description was generated by Pi using OpenAI o3