Automate Documentation Generation for Typescript and React Hooks SDKs

[tinypell3ts]

Problem

Our Typescript SDK and React Hooks SDK currently lack an automated documentation generation process compatible with Docusaurus. The functions in these SDKs use tsdoc commenting, but there is no streamlined method to transform these comments into structured documentation suitable for Docusaurus.

Solution

Implement an automated documentation generation system utilising api-extractor and api-documenter in each SDK package. This system will extract comments from each function and generate comprehensive, structured documentation based on these comments.

Acceptance Criteria

1. Docusaurus Compatibility: Ensure all generated documentation is fully compatible with Docusaurus.
2. Integration of api-extractor and api-documenter: Integrate these tools into the Typescript SDK and React Hooks SDK.
3. Automated Extraction and Compilation: Automatically extract tsdoc comments and compile them into Docusaurus-friendly documentation.
4. Accuracy and Completeness: Documentation must accurately reflect the codebase, including all relevant information from tsdoc comments.
5. Ease of Navigation in Docusaurus: Ensure the documentation is easy to navigate and well-structured within the Docusaurus framework.
6. Automatic Updates: Documentation should update automatically with each SDK update to ensure ongoing accuracy.
7. Testing and Validation with Docusaurus: Conduct thorough testing to validate functionality, output, and compatibility with Docusaurus.

Additional Notes

• Link to our SDKs
• Link to our Docusaurus Docs repo

Tasks

Preview Give feedback

1. Integrate api-extractor and api-documenter into the Typescript SDK and React Hooks SDK #156
   +0
   
2. Render generated markdown with Docusaurus #157
   +0
   
3. Automate extraction and documentation compilation. Automatically update with each release #158
   +0
   
4. Test and validate with Docusaurus #159
   +0
   
5. Accuracy and Completeness - review and improve coverage and completeness of comments #160
   +0