Open abiriadev opened 1 month ago
The current documentation is typedoc, which is not user-friendly as a guide.
Use Vitepress as a document generator so that we can provide more human-readable guides about installing, running the server, configuring, etc.
How can we integrate both typedoc and vitepress?
Currently, there are two options:
api.seia.dev
Generate markdown or Vue code from typedoc JSON output.
Maybe we can use typedoc-plugin-markdown to generate markdown code?
Problem
The current documentation is typedoc, which is not user-friendly as a guide.
Solution
Use Vitepress as a document generator so that we can provide more human-readable guides about installing, running the server, configuring, etc.
Further works
How can we integrate both typedoc and vitepress?
Currently, there are two options:
api.seia.dev
and provide a direct link to typedoc from vitepress.