-
-
Notifications
You must be signed in to change notification settings - Fork 4
Use Vitepress #14
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Projects
StatusShow more project fields
Todo
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.devand provide a direct link to typedoc from vitepress.