Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(add) API Docs in README.md #556

Closed
wants to merge 3 commits into from
Closed

Conversation

gabrielsozinho
Copy link
Contributor

@gabrielsozinho gabrielsozinho commented Jul 23, 2022

Cria a documentação da API conforme sugestão da Issue #555

@vercel
Copy link

vercel bot commented Jul 23, 2022

@gabrielsozinho is attempting to deploy a commit to the TabNews Team on Vercel.

To accomplish this, @gabrielsozinho needs to request access to the Team.

Afterwards, an owner of the Team is required to accept their membership request.

If you're already a member of the respective Vercel Team, make sure that your Personal Vercel Account is connected to your GitHub account.

@gabrielsozinho
Copy link
Contributor Author

gabrielsozinho commented Jul 23, 2022

Sinceramente, acho que ficou muito confuso e/ou bagunçado. (Principalmente porque eu misturei HTML com markdown pra ter o id do overview, e também por algum motivo alguns blocos de código ficaram enormes)

A idéia que eu acho melhor é a do @MattFerreira18.

A proposta dele é criar uma documentação no Redoc.

Fica mais ou menos assim:

E aí só botar um overview no Readme que redireciona pra lá.

@gabrielsozinho gabrielsozinho added the documentação Documentação e organização de processos label Jul 23, 2022
@gabrielsozinho
Copy link
Contributor Author

Vou fechar porque adicionei a tag <details> na PR #557

@Rafatcb Rafatcb deleted the gabrielsozinho-patch-1 branch March 9, 2024 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentação Documentação e organização de processos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant