monocart-coverage-reports icon indicating copy to clipboard operation
monocart-coverage-reports copied to clipboard

[Suggest] Move documentation to vitepress

Open abdul-alhasany opened this issue 6 months ago • 3 comments

Hi Thanks for this library. Since they readme file contains a lot of documentation, I think it might be better to have a dedicated documentation. VitePress is very populate and provides nice UI/UX.

I am happy to help converting documents if there is interest.

abdul-alhasany avatar Jun 12 '25 16:06 abdul-alhasany

Yes, I'm interested in what it will look like after the conversion., please go on.

cenfun avatar Jun 13 '25 00:06 cenfun

I made the initial changes. It can be viewed here. And this is the fork

few notes:

  • I copied the exact data in readme to VitePress, but it can be improved.
  • Simplified Chinese translation is not transfered since I don't know the language. But I prepared the documentation for zh translation.
  • Links to github repo are not updated yet.
  • In the fork, documentation is under documentation folder. Typically it lives under docs, but I realized that docs folder is already used for test generation and github pages.

Let me know what you think

abdul-alhasany avatar Jun 14 '25 14:06 abdul-alhasany

It looks pretty good. I will continue it for another language zh based on your fork. Thanks!

cenfun avatar Jun 15 '25 00:06 cenfun