Installation docs...
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 1/5
- Tempo estimado
- Menos de uma hora
- Facilidade para iniciantes
- 90/100
- Tipo de issue
- Documentação
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
Analise a documentação de instalação existente no diretório docs do projeto, provavelmente em 'getting-started' ou 'installation'. A issue sugere atualizar as instruções para mencionar tanto pip quanto uv, e fornecer um exemplo claro e neutro. Verifique a documentação do mkdocs para as etapas de instalação atuais e revise-as para incluir os comandos sugeridos: 'python3 -m venv venv', 'venv/bin/pip install mkdocs' e 'venv/bin/mkdocs', enquanto também vincula à documentação do uv. Certifique-se de que as alterações sejam feitas nos arquivos markdown corretos e verifique construindo a documentação localmente.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
pip and uv
I suppose let's be staightforward when we can, and link out to step-by-step walk throughs for new comers when needed.
Most of what I'm seeing these days recommends uv and they've got good little docs to point towards.
If we're doc'ing pip then python3 -m venv venv ... venv/bin/pip install mkdocs ... venv/bin/mkdocs is a dependable route.
We might want to use slightly neutral "Install the mkdocs python package..." then the console example.
- Linguagem predominante
- Python
- Estrelas
- 32
- Forks
- 2
- Merge médio
- 8h 51min
- PRs com merge (30d)
- 15
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de encode/mkdocs
-
Licensing Aberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 35/100
-
Reminders... Aberta
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
Todas as issues de encode/mkdocs
Issues semelhantes
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
stephrobert/dsoxlab#238 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
sublimehq/package_control#1780 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
nwg-piotr/nwg-displays#145 ·