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

docs: melhorias de documentação #1

Open
DanielHe4rt opened this issue Oct 1, 2024 · 51 comments
Open

docs: melhorias de documentação #1

DanielHe4rt opened this issue Oct 1, 2024 · 51 comments
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@DanielHe4rt
Copy link
Contributor

Aparentemente o README está com muita pouca informação e eu não entendi como o projeto funciona.

Sugestões

  • Adicionar titulo do projeto
  • Adicionar informações de stacks que desejam utilizar
  • Como instalar o projeto
  • Manual de contribuição

Vocês acham que tem algo faltando aqui?

@DanielHe4rt DanielHe4rt added documentation Improvements or additions to documentation question Further information is requested labels Oct 1, 2024
@DanielHe4rt DanielHe4rt self-assigned this Oct 1, 2024
@devtosh00
Copy link

#UP

@stherzada
Copy link

O que gostariam de ver? :)

@Kremilly
Copy link

Kremilly commented Oct 1, 2024

Oi, YouTube & Microsoft ;)

@JuPazoti
Copy link

JuPazoti commented Oct 1, 2024

Show

@WagnerDorneles
Copy link

#UP

@GabrielMatoss
Copy link

#UP!

@raelis18
Copy link

raelis18 commented Oct 1, 2024

#UP

@mateuspadilha166
Copy link

Manda Salve ._.

@AvaCorrea
Copy link

Concordo!! Vai Microsoft Reactor!!

@giialtoqi
Copy link

#UP

@adriano-allef
Copy link

manda o link do outro projeto que você precisa de contribuição.

@Ganim
Copy link

Ganim commented Oct 1, 2024

Muito bom!

@Daniel-Boll
Copy link

  • Colocar lista de contributores
  • Adicionar as stacks

@georgewneto
Copy link

#UP

@fabiohcnobre
Copy link

Cria um WIKI ???

@LilianMS
Copy link

LilianMS commented Oct 1, 2024

UP

@lorrene
Copy link

lorrene commented Oct 1, 2024

#UP

1 similar comment
@Sales16
Copy link

Sales16 commented Oct 1, 2024

#UP

@renanferri
Copy link

Muito bom

@brunoalvoliveira
Copy link

Arquitetura do Programa

@ricciardone
Copy link

Acho que seria útil comentar como incluir imagens no Readme.md
image

@marcellalcantara
Copy link

#UP

@HenriqueSaKi
Copy link

HenriqueSaKi commented Oct 1, 2024

Seria interessante informar os dados de contato dos desenvolvedores

Devs responsáveis, linkedin, etc..

Esse tipo de modificação pode ser realizado no CODEOWNERS

@lesampietro
Copy link

lesampietro commented Oct 1, 2024

Olá! Nada a adicionar :)

@clesiosalmeida
Copy link

Adiciona os materiais da apresentação. Pfv!🙏

@WalaceLuisSousa
Copy link

Olá

@JohnnatanLopes
Copy link

#UP

@LaissaSaraiva
Copy link

Amando a aula! Obrigada!

@matheushardman
Copy link

Olá, seria legal adicionar as redes dos principais contribuidores.

@jonildoasantos
Copy link

GO!!!

@Kremilly
Copy link

Kremilly commented Oct 1, 2024

Acho que seria util comentar como adicionar blocos de código no README.md

<?php echo "hello, world!"; ?>

@gabrielzerio
Copy link

Aula top

@marcelomarkus
Copy link

👽

@DouglasTecnologia1977
Copy link

up

@Gab-pereir
Copy link

Para ficar completo, seria interessante um guia de padronização dos commits e uma parte que mostra os principais contribuidores!

@adrianaessa
Copy link

#UP

@emanoellavaldevino
Copy link

#UP!

@monicacruzs
Copy link

Olá !

@saviommoreira
Copy link

#UP

@carlohcs
Copy link

carlohcs commented Oct 1, 2024


< E ai pessoal do curso! >

     \   ^__^ 
      \  (oo)\_______
         (__)\       )\/\\
             ||----w |
             ||     ||

@renatinhafront
Copy link

como add badges seria legal..

@Hoyasumii
Copy link

q medo

@mpbeatriz
Copy link

Oie! Aula excelente.

@LilianMS
Copy link

LilianMS commented Oct 1, 2024

Acho que seria útil comentar como incluir imagens no Readme.md image

  • Como colocar imagem:

![Alt da imagem](enderço_da_imagem)

ps: eu uso fundo escuro pra tudo! rsrsrs Até estranhei seu print

@vanzei
Copy link

vanzei commented Oct 1, 2024

Seria interessante mostrar como localmente testar as mudanças feitas no seu fork pra ver se funciona . :)

@DaihSeven
Copy link

estou adorando a aula !!!!!

@AnaRitaRangel
Copy link

Aparentemente o README está com muita pouca informação e eu não entendi como o projeto funciona.

Sugestões

  • Adicionar titulo do projeto
  • Adicionar informações de stacks que desejam utilizar
  • Como instalar o projeto
  • Manual de contribuição

Vocês acham que tem algo faltando aqui?

show

@stefanocarnevalli
Copy link

ok

1 similar comment
@Yurijack
Copy link

Yurijack commented Oct 1, 2024

ok

@carlabetancourt
Copy link

#UP

@walkerataide
Copy link

#up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests