Actions
User Story #47
closed
Feature #38: Setup the documentation website
As a developer, I want to choose an appropriate documentation framework that meets our needs
User Story #47:
As a developer, I want to choose an appropriate documentation framework that meets our needs
Status:
Closed
Priority:
Normal
Assigned To:
Category:
Maintenance
Target version:
Start date:
02/07/2026
Due date:
% Done:
100%
Estimated time:
Description
Evaluate and select a documentation framework (e.g., MkDocs, Docusaurus, VuePress, Sphinx) that fits the project's technical stack and requirements.
Acceptance Criteria:
- Framework supports Markdown
- Easy to customize and theme
- Good community support and documentation
- Compatible with chosen hosting platform
- Decision is documented with rationale
Updated by Bricklou 4 months ago
- Description updated (diff)
- Status changed from Planned to In Progress
The documentation will be made with NuxtJS. The main reason behind this is the ability to easily customize the UI and extends the content with custom components. In addition, it is made using Vue, which means it uses the same frontend library as the project itself.
Actions