[PR #55] Entrepeneur4lyf/api docs #255

New issue

Open

opened 2026-03-02 23:45:38 +03:00 by kerem · 0 comments

kerem commented

2026-03-02 23:45:38 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/anomalyco/opentui/pull/55
Author: @entrepeneur4lyf
Created: 8/22/2025
Status: 🔄 Open

Base: main ← Head: entrepeneur4lyf/api_docs

📝 Commits (6)

c559111 Consolidate and improve API documentation
1143926 Add comprehensive API documentation and CLAUDE.md
c5b555e Add JSON schema generation for API documentation
a31b413 Add JSDoc generation from JSON schemas
58692dd Regenerate API docs: replace old pages with reference
4ffb04c update intellisense import

📊 Changes

98 files changed (+25482 additions, -0 deletions)

View changed files

➕ .vscode/opentui.code-snippets (+219 -0)
➕ .vscode/settings.json (+73 -0)
➕ CLAUDE.md (+78 -0)
➕ packages/core/docs/api/api-summary.md (+427 -0)
➕ packages/core/docs/api/extracted-api.json (+2262 -0)
➕ packages/core/docs/api/index.md (+145 -0)
➕ packages/core/docs/api/reference/README.md (+10 -0)
➕ packages/core/docs/api/reference/classes/ASCIIFontRenderable.md (+265 -0)
➕ packages/core/docs/api/reference/classes/BoxRenderable.md (+344 -0)
➕ packages/core/docs/api/reference/classes/CliRenderer.md (+486 -0)
➕ packages/core/docs/api/reference/classes/InputRenderable.md (+311 -0)
➕ packages/core/docs/api/reference/classes/MouseEvent.md (+109 -0)
➕ packages/core/docs/api/reference/classes/OptimizedBuffer.md (+511 -0)
➕ packages/core/docs/api/reference/classes/Renderable.md (+392 -0)
➕ packages/core/docs/api/reference/classes/RootRenderable.md (+59 -0)
➕ packages/core/docs/api/reference/classes/TextRenderable.md (+228 -0)
➕ packages/core/docs/api/reference/classes/Timeline.md (+225 -0)
➕ packages/core/docs/api/reference/index.md (+43 -0)
➕ packages/core/docs/api/reference/interfaces/ASCIIFontOptions.md (+222 -0)
➕ packages/core/docs/api/reference/interfaces/AnimationOptions.md (+54 -0)

...and 78 more files

📄 Description

Summary

This PR adds complete documentation for all 14 OpenTUI core modules. The documentation is 100% accurate to the actual source code with no assumptions or placeholders.

Developer Experience

Complete TypeScript type definitions
VS Code IntelliSense support
Console debugging with caller information tracking

Testing

All code examples verified against actual API
Type definitions match source exports
No placeholder code or TODO comments

_{🔄 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/55 **Author:** [@entrepeneur4lyf](https://github.com/entrepeneur4lyf) **Created:** 8/22/2025 **Status:** 🔄 Open **Base:** `main` ← **Head:** `entrepeneur4lyf/api_docs` --- ### 📝 Commits (6) - [`c559111`](https://github.com/anomalyco/opentui/commit/c559111619529fd1b755e78b52474a33df2b7ce0) Consolidate and improve API documentation - [`1143926`](https://github.com/anomalyco/opentui/commit/1143926c81f5cc54756a1f6f8918293142645eb1) Add comprehensive API documentation and CLAUDE.md - [`c5b555e`](https://github.com/anomalyco/opentui/commit/c5b555ee9ad59e7a2373bfba8efd188eab2db55a) Add JSON schema generation for API documentation - [`a31b413`](https://github.com/anomalyco/opentui/commit/a31b4131d32dfbbecb8b7cfeee1902b65d3c6b9a) Add JSDoc generation from JSON schemas - [`58692dd`](https://github.com/anomalyco/opentui/commit/58692dd912cd80c71eee88bac8a48b59f101d55a) Regenerate API docs: replace old pages with reference - [`4ffb04c`](https://github.com/anomalyco/opentui/commit/4ffb04c8f8e0da02b7fc4ebd9d877ffa45eec590) update intellisense import ### 📊 Changes **98 files changed** (+25482 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `.vscode/opentui.code-snippets` (+219 -0) ➕ `.vscode/settings.json` (+73 -0) ➕ `CLAUDE.md` (+78 -0) ➕ `packages/core/docs/api/api-summary.md` (+427 -0) ➕ `packages/core/docs/api/extracted-api.json` (+2262 -0) ➕ `packages/core/docs/api/index.md` (+145 -0) ➕ `packages/core/docs/api/reference/README.md` (+10 -0) ➕ `packages/core/docs/api/reference/classes/ASCIIFontRenderable.md` (+265 -0) ➕ `packages/core/docs/api/reference/classes/BoxRenderable.md` (+344 -0) ➕ `packages/core/docs/api/reference/classes/CliRenderer.md` (+486 -0) ➕ `packages/core/docs/api/reference/classes/InputRenderable.md` (+311 -0) ➕ `packages/core/docs/api/reference/classes/MouseEvent.md` (+109 -0) ➕ `packages/core/docs/api/reference/classes/OptimizedBuffer.md` (+511 -0) ➕ `packages/core/docs/api/reference/classes/Renderable.md` (+392 -0) ➕ `packages/core/docs/api/reference/classes/RootRenderable.md` (+59 -0) ➕ `packages/core/docs/api/reference/classes/TextRenderable.md` (+228 -0) ➕ `packages/core/docs/api/reference/classes/Timeline.md` (+225 -0) ➕ `packages/core/docs/api/reference/index.md` (+43 -0) ➕ `packages/core/docs/api/reference/interfaces/ASCIIFontOptions.md` (+222 -0) ➕ `packages/core/docs/api/reference/interfaces/AnimationOptions.md` (+54 -0) _...and 78 more files_ </details> ### 📄 Description Summary This PR adds complete documentation for all 14 OpenTUI core modules. The documentation is 100% accurate to the actual source code with no assumptions or placeholders. Developer Experience - Complete TypeScript type definitions - VS Code IntelliSense support - Console debugging with caller information tracking Testing - All code examples verified against actual API - Type definitions match source exports - No placeholder code or TODO comments --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>