docs: use vitepress#3921
Conversation
|
I would recommend to use https://rspress.dev/ |
|
Pending discussion on #3905 (comment) |
b1994cd to
badf56c
Compare
|
I finished the main implementation of the docs using Tip If anyone want to take a look you can checkout this branch and try it locally and let me know what you think! @escapedcat, @JounQin if you have time I would like to hear any feedback! @escapedcat, I have a question about automatic installation: When opening "Actions" pages I see that a "pages build and deployment" workflow exists: However Inside Probably there is some kind of magic that I'm missing here 😅. Just for reference this is the official |
|
Thanks for the info.
The new doc requires a build step before is ready for deploy. Anyway there is more job to do before this 😀 One last question: do you want to add a copyright in the footer? |
No need, I think we're good without, right? |
972136f to
c67473b
Compare
|
I completed the doc update. PR description is updated with all relevant changes. I added also the Let me know if other changes are needed 😉. After merge GitHub Pages repo settings should be updated as described in my previous comment. I never deployed pages on a custom domain so I'm not sure if other things should be update in the workflow / repository settings 😅. |
c67473b to
b90afc3
Compare
7e6135f to
81fea2a
Compare
|
I have applied all requested changes. Let me know if other changes are needed. |
81fea2a to
e6739e0
Compare
|
Thanks for your review @JounQin! |
|
@escapedcat, if you don't have changes that needs to be applied, new documentation is ready for merge. |
|
I just noticed that were many link pointing to the documentation with a I update all of them pointing to new the docs pages paths and to use |
|
Thanks for pulling this off @marcalexiei . Will try to merge and deploy this soon. |
|
Merged. Exciting. Let's hope for the best 🤞 |
|
Had to update the branch-name, we're still on Thanks everyone! You keep this alive! |
|
@JounQin would create a new major release tomorrow if you're good with that. |
|
I would be glad for fixing any issues. 😁 |
* docs: use vitepress * docs: update src docs references


Description
Use
vitepressto build doc.Motivation and Context
See associated issue: #3905
Usage examples
n/a
TODOs
Add copyright in the footer?not neededprettieron docs files when necessarymodule.exportsin examples with ESM examplesNav changes
Guides
"Release" and "Upgrade commitlint" have been moved inside "Support"
new "Getting started" page inside Guides (contains shared item for "Local setup" and "CI setup")
References
Rules page has been divided into two pages:
API
New section with a single page for each package (format, lint, load and read)
Support
a new collapsible section named "Support" which contains section.
In the future will include more content like troubleshooting information (#3894)
"Attributions"
new section with previous "Attributions" from docs/README.md content
Page preview (WIP)
Home
Guides: Local setup
References: Rules