Brigade: Improve documentation

Created on 4 Jan 2019  路  5Comments  路  Source: brigadecore/brigade

This issue tracks the re-vamping of the documentation for Brigade - specifically, clean sections for user guide, coding reference, admin guide.

related: #748, #79, #314, #450, #451. #506, #595

TODO

(TODO list added by vdice 1/23/19; last edited 1/31/19)

docs v1.0

Most helpful comment

Yes!!
Thanks a lot, everyone!

And particularly, thanks to @vdice, who has been absolutely fantastic working on docs last few weeks.

All 5 comments

One thing that I think should be fixed is the navigation in topics. As soon as I visit any page, e.g. this, there is no easy way to return to the table of contents unless I use browser's back button.

I'll take this one on. As the description is fairly far-reaching, I'll start to ensure all of the referenced tickets are covered, as well as the note from @dgkanatsios and then put up a PR...

Question: currently, the landing page is on one domain (brigade.sh), while the documentation is directly on GitHub Pages - would it make sense to move the docs under docs.brigade.sh?

If so, I'll add an item on the list.
Thanks!

We're getting close!! Added @radu-matei as an asignee as I believe he's cooking up docs around remote/local js module use.

Yes!!
Thanks a lot, everyone!

And particularly, thanks to @vdice, who has been absolutely fantastic working on docs last few weeks.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

blimmer picture blimmer  路  3Comments

mattfarina picture mattfarina  路  4Comments

LittleColin picture LittleColin  路  7Comments

danmx picture danmx  路  7Comments

philmay picture philmay  路  4Comments