Documentation website

[fabiospampinato]

We should have a documentation website, perhaps generated from our readme or the other way around, in order to make it easier for people to learn about Cash and browse its functionalities.

If anybody would like to spend the time to make it it'd be awesome.

[Richienb]

typedoc sort-of works:

[balazsbotond]

@fabiospampinato I had the same need with my project and someone suggested docsify. I'm very satisfied with the result. All you need is a couple of .md files in your github pages folder and an index.html which includes docify's javascript and CSS. It generates a documentation site on the client side from the Markdown source. This way you can start with just using your README as the website and then incrementally break out sections from it and create separate pages for them. Setting it up doesn't take more than 15 minutes. And later, if you feel like your project has outgrown it, it is very easy to replace with a static site generator.

If you like this solution, I can implement it in a PR.

[fabiospampinato]

@balazsbotond There's been some discussion on the matter here: #345

IMHO just setting up something quickly in 10 minutes wouldn't be that useful, but getting something more tailored for our use case is where the value is.

[varunsridharan]

@fabiospampinato i am using gitbook and its awesome may be give that a try ?
if that works for you then i can work on docs site

[fabiospampinato]

@varunsridharan Sure, we can give it a try. Make sure to read my comments on the previous attempt here though: #345 (comment)

[tristan-f-r]

mdbook seems to be a better open source alternative to gitbook.