[PR #517] [MERGED] docs: update solid README to provide some base level documentation, similarly to the react package README #1375

New issue

Closed

opened 2026-03-14 09:33:20 +03:00 by kerem · 0 comments

kerem commented

2026-03-14 09:33:20 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/anomalyco/opentui/pull/517
Author: @bryceosterhaus
Created: 1/13/2026
Status: ✅ Merged
Merged: 1/15/2026
Merged by: @Adictya

Base: main ← Head: solidDocs

📝 Commits (1)

47036e7 docs: update solid README to provide some base level documentation, similarly to the react package README

📊 Changes

1 file changed (+133 additions, -0 deletions)

View changed files

📝 packages/solid/README.md (+133 -0)

📄 Description

I was using solid with opentui for the first time and had a hard time finding docs for some of the basic functionality and components. These basic docs might help some people onboard a bit quicker. I copied the general format of the docs in the react package.

If this isn't needed, feel free to close.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/anomalyco/opentui/pull/517 **Author:** [@bryceosterhaus](https://github.com/bryceosterhaus) **Created:** 1/13/2026 **Status:** ✅ Merged **Merged:** 1/15/2026 **Merged by:** [@Adictya](https://github.com/Adictya) **Base:** `main` ← **Head:** `solidDocs` --- ### 📝 Commits (1) - [`47036e7`](https://github.com/anomalyco/opentui/commit/47036e71ab126077e8e2956862de631d9069e86c) docs: update solid README to provide some base level documentation, similarly to the react package README ### 📊 Changes **1 file changed** (+133 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `packages/solid/README.md` (+133 -0) </details> ### 📄 Description I was using solid with opentui for the first time and had a hard time finding docs for some of the basic functionality and components. These basic docs might help some people onboard a bit quicker. I copied the general format of the docs in the react package. If this isn't needed, feel free to close. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>