jingo icon indicating copy to clipboard operation
jingo copied to clipboard

Published 20 hours ago • verified publisher icon claudioc

Documentation

Open almereyda opened this issue 9 years ago • 3 comments

Looking at the repo's issue activity, it appears to me Jingo has an existing user base and a living developer community.

As there are multiple known use cases and custom adaptations, different approaches in running and utilizing Jingo could be documented in self-contained documentation within the repository itself.

  • [ ] If put in the docs subfolder, Markdown documentation will easily be rendered by http://progrium.viewdocs.io/viewdocs/ - which also offers some kind of templating one could try to align with the approach here.
  • [ ] Hypothes.is and nginx cases could be presented
  • [x] The main README could be trimmed down to administrative essentials, extended by a CONTRIBUTING.md

The list above could be exteneded, of course, but may suit as a template for a PR implementing this. The content could be staged in this project's (currently not activated) wiki.

almereyda avatar Dec 13 '15 16:12 almereyda

I agree: the README starts to be a bit too big and maybe can be trimmed and the references and use cases moved to the docs folder or the wiki. I think the wiki is better (today I just had to release a version just because I forgot to remove a line from the README. Silly).

I just opened the wiki, in the meanwhile :D

claudioc avatar Dec 14 '15 22:12 claudioc

In the meantime: I added a CONTRIBUTING file, and some Wiki pages.

I'd like to remove the settings reference from the README too.

claudioc avatar Dec 28 '15 10:12 claudioc

Wouldn't it be more interesting and appropriate to host the project wiki using Jingo?

philippnagel avatar Jan 31 '16 21:01 philippnagel