Design + Marketing + layout about brasilapi HOT 6 CLOSED

Acredito que por ser uma iniciativa "nova" focada mais na parte da API, eles não tem tanta preocupação com isso. Mas podemos ir pensando sobre algo assim com o tempo. Também estou pensando em fazer algum layout com o estilo básico de sites de API, colocando uma sidebar com os tópicos, toda a documentação com um layout fixo, etc. Podemos ir conversando mais sobre isso!

from brasilapi.

Pessoal, com relação a documentação, vale lembrar que já tem um PR sobre aqui #101 , incluso a pessoa que fez o PR acatou a sugestão do ReDocs ;-)

from brasilapi.

Cara, com relação a layout para a documentação nem precisa desenvolver muita coisa, tem alguma ferramentas prontas, como o Swagger UI, eu utilizo uma que usa as especificações da openapi (Do swagger, por consequência) chamada Redoc (https://redocly.github.io/redoc/), seria interessante mesmo um layout para o site.

from brasilapi.

Acho uma ótima ideia disponibilizar a documentação com openapi e Redoc, jogava em um docs.brasilapi.com.br, ficaria bem legal e poderíamos já utilizar a documentação como forma de SEO para o produto(Brasil API).

from brasilapi.

Bem lembrado o uso do subdomínio e o SEO, com certeza dará mais visibilidade ao projeto.
Fora que o uso de uma lib opensource acho que ficaria mais alinhado a proposta do projeto.

from brasilapi.

só para linkar com essa issue, #93

from brasilapi.