render[bot]
commented
1 month ago Your Render PR Server URL is https://one00hunters-pr-50.onrender.com.
Follow its progress at https://dashboard.render.com/web/srv-cnvj3p8l5elc73fpq520.
Closed Angra974 closed 1 month ago
render[bot]
commented
1 month ago Your Render PR Server URL is https://one00hunters-pr-50.onrender.com.
Follow its progress at https://dashboard.render.com/web/srv-cnvj3p8l5elc73fpq520.
feat: Documentation with Vitepress
Solves #47 #45 #35
Description
the purpose of this pull request: It's not easy to navigate on the documentation files and find easily the information we need. With vitepress, we can navigate in the documentation like in a real website as we are in an SPA. Vitepress use a folder based routing system so it's easy to create navigation and organisation in our file.
What problem does it solve : Navigate easily in the documentation and help to organize our documentation. Can add plugins to our documentation website with plugins provide by vite or vitepress. It's easy to create our "get stated page" as we already know how to install the application and we can navigate in the different page ( of the documentation ) to get the information needed to set it up. No need to open multiple markdown file and lost ourself inside.
what functionality does it add? We can use plugin to add functionnalities to vitepress. One of them is the ability to use mermaid diagram in vitepress, it will solde #45 and we can have these diagram directly in our documentation without the code or with the code alongside the diagrams ( need to duplicate nevertheless :( )
No need for specific user stories or issues ( the issue use for this PR will be closed at the same time the merge will be done).
Testing
Screenshots/Demo (optional)
video shot
Breaking Changes (optional)
No breaking change, all change are made in the docs folder and we need to add scripts in package.json with new modules ( vitepress + vitepress plugin for using mermaid + mermaid )
Checklist
Reviewer Checklist