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.

Sign up for GitHub

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

Jump to bottom

Tornar README mais enxuto #148

Open
3 tasks
Tracked by #219
arthurTemporim opened this issue Sep 11, 2020 · 0 comments
Open
3 tasks
Tracked by #219

Tornar README mais enxuto #148

arthurTemporim opened this issue Sep 11, 2020 · 0 comments
Labels
📝 documentação Documentação necessária evolucao Nova feature ou pedido 🍭good first issue Issue simples, boa para novos contribuidores

Comments

@arthurTemporim
Copy link
Collaborator

arthurTemporim commented Sep 11, 2020 •
edited by BrunaNayara
Loading

Tornar README mais enxuto

Atualmente o README.md é um arquivo longo, cheio de informações sobre todo o projeto. Porém existem informações que não são relevantes para o primeiro contato com o projeto (analytics, notebooks, etc).

A proposta de quais informações são realmente necessárias, atualização do README e reorganização da documentação são necessárias

Tarefas:

  • Identificar partes que podem sair do REDME
  • Propor novo README
  • Mover conteúdos removidos para outras partes da documentação (github pages do projeto ou pastas específicas)
@arthurTemporim arthurTemporim added evolucao Nova feature ou pedido 🍭good first issue Issue simples, boa para novos contribuidores 📝 documentação Documentação necessária labels Sep 11, 2020
@arthurTemporim arthurTemporim mentioned this issue Oct 24, 2021
Merged
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📝 documentação Documentação necessária evolucao Nova feature ou pedido 🍭good first issue Issue simples, boa para novos contribuidores
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@arthurTemporim