operable / cog-book

Cog's Documentation in book form
https://operable.github.io/cog-book/
Other
13 stars 10 forks source link

Give users a way of suggesting changes to Cog-Book #70

Closed Shelton closed 7 years ago

Shelton commented 7 years ago

We need to give users a way of suggesting edits to any part of Cog-Book. Preferably, we link them to the exact Markdown file where they can then make the change and submit it. These will not commit to master, a PR will be created for us to review.

This process: https://help.github.com/articles/editing-files-in-another-user-s-repository/

To do:

Shelton commented 7 years ago

@kevsmith researched how to use Sphinx as an alternative to ASCIIDoctor. A Sphinx build would help break the documentation down into separate pages that could then be PRed against.