pedsmoreira / battlecry

Open source scaffolding CLI for everyone

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Better documentation

raulfdm opened this issue · comments

@pedsmoreira what you think about a site with battlecry documentation?

https://github.com/facebook/Docusaurus

That would be very cool.

I looked at Docusaurus and although it seems very customizable, it also seems like it could take a lot of time in design chores.

I did some research and I think GitBooks would be a good option for this case because it deploys itself and can easily be managed with just markdown files, no further configuration. I went ahead and set it up: https://battlecry.gitbook.io/battlecry/ - it's reflecting the files under the /docs folder

If you or someone else is willing to take on the responsibility of designing the website, I'd support Docusaurus or another tool of choice to create a website per se, otherwise, I think something like GitBooks solves the problem, specially because it's a lot quicker.

I'm in! I'll mock Docusaurus and show you... after I setup everything (with the docs, etc) I can eight try to do by myself or find a designer/UX to give some colors. :)