LoopPerfect / buckaroo

The decentralized package manager for C++ and friends 🏝️
https://buckaroo.pm
MIT License
935 stars 33 forks source link

Buckaroo Docs Website #313

Closed abranhe closed 1 year ago

abranhe commented 5 years ago

I saw the new structure of the Buckaroo project, you guys moved all the documentation to the wiki page. I think that's alright but I decided to create a website for the Buckaroo Documentation.

screenshot

Check it out https://buckaroo.netlify.com/ and share your thoughts.

was created with Docusaurus (a Facebook project to create documentation websites build on React). The demo is hosted on Nelify and I really recommend to publish it there, and it will be nice to have the Buckaroo documentation at https://docs.buckaroo.pm as I wrote on the Documentation website blog.

shot

Repository: https://github.com/abranhe/buckaroo-docs

nikhedonia commented 5 years ago

@abranhe this is amazing! We are really blown away by your initiative! Unfortunately we didn't expect your contribution and it just happen that we deployed a new page just today.

We will try to be more transparent about the things we are working on.

abranhe commented 5 years ago

@nikhedonia it looks great, but the page you guys upload it is not up to know a documentation page as I appreciate.

This website buckaroo.netlify.com/docs already have the documentation created, and it was written in pure mardown, so it is easier to write documentation.

And it doesn't need to be on the root website (https://buckaroo.pm) it would be great to have it at https://docs.buckaroo.pm. Also Docusaurus it is capable to manage documentation for different versions and with support for website translation using Crowdin, which is great.

njlr commented 5 years ago

The code for the blog and landing page is here: https://github.com/buckaroo-pm/buckaroo-pm.github.io It uses Markdown and JSX. It also has really fast transitions when JS is enabled (preload) and graceful fallback when JS is disabled.

Would it be possible to integrate the Docusaurus docs pages into this? Or alternatively integrate that into Docusaurus?