Open Source Documentation System for GitHub

As something that wasn’t currently available, and also something I could actively use, I created a code wiki for my GitHub repos. It can:

• • Gather all the documentation across my wildly growing different GitHub repos, both public and private, and have them in one searchable central location. 
  • Add new docs to each repo from this view.
  • Create additional documentation notes for all of them, or any arbitary group of them. Or any other useful topics.
  • Create documentation that can sit in its repo.

This code wiki can also inherit all of a GitHub user’s permissions for their public or private repos, and detect and provide links if the repos are staged. For example, on my current preferred host Netlify. It can even inherit other people’s permissions for private repos, so they can document them through their own accounts. It also will hide any documentation in private repos from people who aren’t logged in, and the user can set any other docs outside of repos to be private also.

Finally, for good documentation habits, I set it to flag any repos that currently have no root docs.

So, I’m sharing it as open source! Check it out and fork it for your own repos if you like.

On GitHub.

Live proof of concept.