tabnews.com.br
tabnews.com.br copied to clipboard
filipedeschamps
[sugestão] criar documentação da API
E aí turma!
Como no futuro esse projeto vai se tornar público, e até, para melhorar a DX para os novos devs que querem se aventurar no projeto (assim como eu kk), queria propor de a gente implementar alguma documentação da API.
De lib para montar a documentação, uma que particularmente gostei muito foi a Redoc, que foi até implementada no BrasilAPI.
O que vocês acham?
Opa, eu to trabalhando na criação da documentação. Primeiro eu vou postar lá no TabNews mesmo, e se aceito, depois a gente implementa a Redoc. O que acha?
Opa, eu to trabalhando na criação da documentação. Primeiro eu vou postar lá no TabNews mesmo, e se aceito, depois a gente implementa a Redoc. O que acha?
TOP! Gostei da ideia.
Acabei de publicar a primeira versão da documentação lá no TabNews! https://www.tabnews.com.br/GabrielSozinho/documentacao-da-api-do-tabnews
Massa, acabei criando um PR usando Redoc: https://github.com/filipedeschamps/tabnews.com.br/pull/599
Apenas registrando aqui os PRs que já foram abertos e que podem servir de inspiração para a criação de um PR atualizado:
- #557
- #599
- #799
Olá, equipe!
Gostaria de sugerir a criação de uma documentação para este repositório, utilizando a plataforma Docs Page. Aqui estão algumas das vantagens:
-
Fácil Configuração: O Docs Page permite gerar documentação diretamente a partir dos arquivos markdown (.md) existentes no repositório.
-
Atualizações Automáticas: Sempre que um arquivo markdown é alterado no repositório, a documentação é atualizada automaticamente.
-
Interface Simples: Oferece uma interface limpa e fácil de navegar, ideal para desenvolvedores e usuários finais.
-
Gratuito: A plataforma é gratuita e pode ser integrada sem a necessidade de grandes configurações adicionais.
Acredito que adicionar uma documentação organizada irá melhorar a experiência dos colaboradores e novos usuários e menos confuso 😕.
O que acham?
https://docs.page/ https://docs.page/get-started
@Rafatcb @gabrielsozinho @aprendendofelipe
O Docs Page me pareceu um site interessante para criar a documentação, e poder escrevê-la em Markdown seria ótimo, pois permite a leitura pelo próprio repositório, facilita a manutenção e independência do "serviço de documentação", mas não me parece um site de documentação de API.
Dois PRs abertos usaram o Redoc, que não cheguei a ver. Seria interessante termos alguns sites de referência para entendermos o caminho que queremos tomar, também.
Dois PRs abertos usaram o Redoc, que não cheguei a ver. Seria interessante termos alguns sites de referência para entendermos o caminho que queremos tomar, também.
Que tal https://redocly.com/docs ?
@imattferreira dê uma olhada também.