Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Buckaroo Docs Website #313

Closed
abranhe opened this issue Feb 12, 2019 · 3 comments
Closed

Buckaroo Docs Website #313

abranhe opened this issue Feb 12, 2019 · 3 comments

Comments

@abranhe
Copy link
Contributor

abranhe commented Feb 12, 2019

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
Copy link
Collaborator

@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
Copy link
Contributor Author

abranhe commented Feb 13, 2019

@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
Copy link
Collaborator

njlr commented Feb 14, 2019

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?

@abranhe abranhe closed this as completed May 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants