Gosto de adicionar a documentação diretamente ao meu repositório no GitHub. Acho que é a maneira mais fácil de garantir que as pessoas obtenham a documentação junto com o código, e que também seja versionado (e marcado!) Junto (o que seria muito mais difícil de conseguir com submódulos do GitHub, IMHO).
Seja como for, sempre vejo que as pessoas têm dificuldade em pesquisar a documentação. Comecei a adicionar isso ao meu arquivo README.md para ajudá-los a contornar esse problema:
[Search the documentation](../../search?l=markdown&q=&type=Code)Isso apresentará ao usuário uma tela de onde ele pode pesquisar apenas os documentos do Markdown, com o cursor de texto já focado na caixa de pesquisa.
Claro, isso funciona bem para mim porque eu documento no formato Markdown, mas você poderia adaptar este exemplo para funcionar com outros formatos bem suportados pela interface da web do GitHub.