Sincronizar a documentação entre a fonte e o wiki no Github

Você pode ter uma docpasta em seu projeto, cheia de documentação que você mantém enquanto trabalha nele.

Você também pode ter um wiki no github com ainda mais documentação, que não está na fonte (ou documentação na fonte que não está no wiki).

Você pode mantê-los sincronizados com o Git, e o Github é inteligente o suficiente para saber:

# change 'docs' at the end to whatever... or just omit it
git submodule add git@github.com:USER/REPO.wiki.git docs

Copie seus outros documentos no repositório de submódulo, se desejar, e depois envie e envie. Wiki atualizado!

Você não pode acessar o repositório wiki diretamente, como faz com o seu próprio. No entanto, quando você tenta navegar até ele na árvore de código-fonte no Github, ele o levará direto para o wiki.

O resultado final é a documentação que fica dentro de sua cópia de trabalho para referência offline, que pode ser facilmente sincronizada com o wiki e vice-versa.

Também significa que os usuários em potencial sempre veem um wiki atualizado, sem ter que clonar o repositório para obter a documentação real.