Choo: Website

Created on 6 Jul 2016  路  3Comments  路  Source: choojs/choo

For a framework, documentation is very important, so making it as accessible as possible is also important. A single markdown file can only go so far, so I'm wondering if you've thought of setting up a proper website for docs/api?

There are a few nice options out there, like https://github.com/rstacruz/flatdoc

Most helpful comment

I feel this is done now :sparkles: http://choo.io/ - handbook.choo.io is still a WIP tho, but that should be done soon I hope (fingers crossed)

All 3 comments

Hey, thanks for opening this :sparkles: We def agree with you - that's why we've started building the choo handbook and I did a bit of work on creating an actual website a couple of weeks back. Neither of which are finished, but we'd love for people to get involved with this!

The handbook is built using minidocs, which in turn is built using choo - it shouldn't be too different from flatdoc I reckon (perhaps less polished, but we'll get there hah). Tl;Dr: working on it, all help is welcome! :sparkles:

When the FeathersJS team switched its docs to GitBook, we saw a huge boost in edits from the community. You can see an example here: http://docs.feathersjs.com/. We also like the automatic CD that builds the docs in five formats. The web version does allow highlighting and discussion, but we decided to turn that off and keep the discussion in GitHub issues.

I feel this is done now :sparkles: http://choo.io/ - handbook.choo.io is still a WIP tho, but that should be done soon I hope (fingers crossed)

Was this page helpful?
0 / 5 - 0 ratings