Documentar seu projeto com wikis
Você pode usar um wiki para compartilhar informações longas e detalhadas sobre seu projeto.
Wikis are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server.
About wikis
Você pode hospedar a documentação para seu repositório em um wiki para que outras pessoas possam usar e contribuir com seu projeto.
Adding or editing wiki pages
Você pode adicionar e editar páginas wiki diretamente no GitHub Enterprise ou localmente usando a linha de comando.
Creating a footer or sidebar for your wiki
Você pode adicionar uma barra lateral ou um footer personalizado para seu wiki a fim de fornecer aos leitores informações mais contextuais.
Editing wiki content
Você pode adicionar imagens e links no conteúdo do seu wiki e usar alguns formatos do MediaWiki compatíveis.
Viewing a wiki's history of changes
Como wikis são repositórios do Git, cada alteração que você faz é um commit que pode ser exibido.
Changing access permissions for wikis
Somente colaboradores de repositório podem editar o wiki de um repositório público por padrão, mas você pode permitir que qualquer pessoa com um GitHub Enterprise edite seu wiki.
Disabling wikis
É possível desabilitar wikis do repositório.