Iniciar com a documentação

[ghost]

Descrição da feature:
Iniciar com a criação da documentação da biblioteca.

Necessidade:
Documentar o código é bom, mas ter uma boa documentação é extraordinário. Você já deve ter tentado usar alguma funcionalidade de alguma lib e a mesma não tinha uma boa documentação ou até mesmo nem tinha né ? Por isso queremos dar inicio logo a criação da documentação.
Isso vai ajudar até mesmo a pessoas que queiram contribuir, facilitando o seu entendimento do código.

Implementação:
Pode ser colocada na pasta docs no arquivo README e a partir desse arquivo seria possível navegar para as demais documentações. Descrevendo a funcionalidade e no minimo um exemplo de uso.

[gabrielvassoler]

Estava pensando nas estratégias de documentação e fiquei em dúvida quanto à localidade dos arquivos. Seria mais interessante centralizá-los em um arquivo só (por exemplo, criar um .md somente para isso) ou gerar um arquivo para cada um dos módulos (por exemplo, um arquivo para o SimpleGraph, um para os testes, etc.) ?

Fico no aguardo da resposta e me coloco a disposição para ajudar no preenchimento da documentação :)

[ghost]

Eu acho que poderíamos criar uma pasta docs, criar um arquivo principal, possuindo os tópicos da biblioteca e a partir dele conseguiremos ir a todos os outros tópicos.

Ex:

./docs/MAIN.md

Nesse arquivo teria tipo um sumário levando para os demais tópicos.

./docs/graphs/SimpleGraph.md

Nesse arquivo teria a documentação, com exemplos do funcionamento da classe.

O que você acha?

[gabrielvassoler]

Eu achei uma ótima ideia!

Você acha importante fazer uma explicação básica sobre a classe antes de entrar nos detalhes do funcionamento/uso das funções?

[ghost]

Seria algo bem positivo, assim o usuário teria uma noção maior do objetivo daquela classe e também o que ela pode fazer.

[ghost]

Documentação iniciada. Será criadas novas issues para documentar cada funcionalidade.