Entrepeneur4lyf/api docs #55
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Consolidates duplicate renderable.md and renderer.md files - Creates organized structure under /components/ and /core/ - Adds comprehensive API references for all components - Includes complete examples and type definitions - Documents future FontDefinition API for custom fonts
- Adds complete API documentation for all OpenTUI components - Creates organized documentation structure with proper categorization - Includes CLAUDE.md guide for future Claude instances - Documents all renderables, utilities, 3D features, and animations - Provides code examples and type definitions for each component - Consolidates duplicate files into proper locations
- Created generate-api-schemas.sh script using ts-json-schema-generator - Generated 17 JSON schemas for core OpenTUI types: - Renderable options (ASCIIFont, Box, Text, Input, Select, etc.) - Core types (RenderableOptions, LayoutOptions, CliRendererConfig) - 3D/Animation types (ExplosionEffectParameters, ThreeCliRendererOptions) - Library types (BorderConfig, BoxDrawOptions) - Schemas provide accurate, type-safe API documentation - Can be used for validation, IDE support, and documentation generation
- Created multiple scripts to convert JSON schemas to JSDoc - Used json-schema-to-jsdoc library for automatic conversion - Generated JSDoc typedefs for all 17 OpenTUI types - Includes both individual files and combined all-types.js - JSDoc includes auto-descriptions and proper type formatting - Can be used for IDE support and inline documentation
Regenerate API documentation output: remove legacy topic pages under packages/core/docs/api and add a consolidated reference tree (packages/core/docs/api/reference/*), a new api-summary.md and machine-readable extracted-api.json. Update index.md to reflect the new layout. Add .vscode snippets/settings and update .gitignore. Switch to the new API reference generation format and clean up obsolete docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Testing