feat/vitepress #52
Draft
feat/vitepress #52
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Your Render PR Server URL is https://one00hunters-pr-52.onrender.com. Follow its progress at https://dashboard.render.com/web/srv-co04m0i0si5c73cuv3t0. |
alcpereira
reviewed
Mar 30, 2024
| @@ -1,5 +1,9 @@ | |||
| node_modules | |||
|
|
|||
| # viteoress cache file | |||
There was a problem hiding this comment.
Suggested change
| # viteoress cache file | |
| # vitepress cache file |
| @@ -72,11 +76,14 @@ | |||
| "tsx": "^4.7.1", | |||
| "typescript": "^5.1.6", | |||
| "vite": "^5.1.0", | |||
| "vite-tsconfig-paths": "^4.2.1" | |||
| "vite-tsconfig-paths": "^4.2.1", | |||
| "vitepress": "1.0.0-rc.45", | |||
| @@ -1,5 +1,9 @@ | |||
| node_modules | |||
|
|
|||
| # viteoress cache file | |||
| /docs/.vitepress/cache | |||
| /docs/.vitepress/cache/deps | |||
There was a problem hiding this comment.
Suggested change
| /docs/.vitepress/cache/deps |
|
|
||
| We have very precise rules over how our Git commit messages must be formatted. This format leads to easier to read commit history. | ||
|
|
||
| For more information see [commit-message](commit-message.html) |
There was a problem hiding this comment.
Do we need the .html extension? I think it's not needed, especially with Markdown.
| export default withMermaid( | ||
| defineConfig({ | ||
| optimizeDeps: { | ||
| include: ["dayjs", "mermaid"], |
| - Remember to update `environment.d.ts |
There was a problem hiding this comment.
Suggested change
| - Remember to update `environment.d.ts | |
| - Remember to update `environment.d.ts` |
There was a problem hiding this comment.
Can we use vite.config.ts ? Maybe even vite.vitepress.config.ts
| @@ -0,0 +1,49 @@ | |||
| // .vitepress/config.js | |||
There was a problem hiding this comment.
Suggested change
| // .vitepress/config.js |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
No testing procedure and no unit test.
Just installing the vitepress module, make it run and create the documentation with it and reorganized the folder.
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