Improve API Documentation / customization experience

[tmkasun]

Describe your problem(s)

Our current API documentation options seem quite outdated now

Like public forum URLs, Support etc.

This issue is created for tracking the improvements of API documentation

Describe your solution

Markdown-based documentation methods are quite popular nowadays

example:

• MDX : Markdown + JSX(React)
• Remark
• Docz

A major problem with those methods is , they either need NodeJS backends or require a re-run of the build.

MDX-Bundler seems like a good solution to nodejs dependency.

The above solutions are good for integrating React components with Markdown content to provide rich documentation experience.

Otherwise, For pure markdown editing and rendering, We could try

• tui.editor

It has plugins to render most common requirements with API documentation

like

• Embedding code snippets
• UML diagrams
• +++ all the Markdown features

[tmkasun]

@tgtshanika , @bhathiya Just a suggestion, WDYT ?

[tmkasun]

Example: Check out this documentation page

[tmkasun]

Block is also a good WYSWG editor which use MDX behind the seen. I think they have used Redoc

[tmkasun]

Here is another MDX rendere https://github.com/code-hike/codehike

[tmkasun]

https://github.com/markdoc/markdoc

[tmkasun]

API Matic