Skip to content

Instantly share code, notes, and snippets.

@wangmxf

wangmxf/project_documentation_methods.md

Forked from devnulled/project_documentation_methods.md
Created December 30, 2013 04:17
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save wangmxf/8177728 to your computer and use it in GitHub Desktop.
Save wangmxf/8177728 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
project_documentation_methods.md

GitHub Project Documentation Methods

Just a quick guide on methods I've seen to document GitHub projects. This is not a complete list by any means, just things I've ran across and bookmarked.

More Common

  • GitHub Wiki's
  • GitHub Sites
  • A directory of markdown or AsciiDoc files
  • Sphinx generated documentation

Haven't Seen In Use But Worth A Look?

Misc

  • Publish your documents to Read the Docs so they are searchable, etc. I'd imagine this works well with Sphinx generated docs.
  • Document REST API's with Swagger
  • Keep a personal wiki using Gollum (the GitHub wiki engine) instead of something like Evernote
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment