ramontrovao / github-blog

Github Blog - ReactJS | Typescript | Axios | Styled-components
https://github-blog-vert.vercel.app
1 stars 0 forks source link

Como fazer uma documentação? #2

Open douglasfdev opened 1 year ago

douglasfdev commented 1 year ago

Você precisa de um titúlo para sua aplicação, igual a este

Você precisa de sub tópicos mostrando como funciona seu app igual a este

Exemplo de Rotas

Rotas ```http GET http://localhost:3001/users/${id} ``` | Parâmetro | Tipo | Descrição | | ----------- | -------- | ---------------------------| | `authentication` | `string` | **Obrigatório**. O Token passado como Bearer da API no Header|

Exemplo de Árvore do App

Árvore do App ``` src ├── app │ └── components │ │ ├── componente1 │ │ ├── component2 │ │ ├── component3 │ └── pages │ │ ├── page1 │ │ ├── page2 ...etc. ```

Exemplo de Techs e Bibliotecas

Techs Motivos
NodeJS Foi usado nodejs por X, Y ou Z motivos
TypeScript Foi usado TypeScirpt por X, Y ou Z motivos
Biblioteca 1 Foi usado essa biblioteca porque ela resolve X, Y ou Z coisa
Framework Foi usado do framework A porque ele faz X, Y ou Z de uma maneira melhor

Me

ramontrovao commented 1 year ago

Boa! Isso aqui é só um teste pra ver se tá funcionando o contador de commentários