Add see-also section to command docs for better discoverability
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 40/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- markdown
- Domínio
- documentation
Direção de pesquisa
Comece localizando os arquivos (.md) de referência dos comandos e revisando como as saídas atuais de ajuda apresentam suas seções Examples. Adicione as referências cruzadas acordadas abaixo desses exemplos, usando como exemplo a relação entre enter e shells. O trabalho estará concluído quando a documentação dos comandos relevantes incluir consistentemente seções See also úteis.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
The command docs are fantastic. I'm a new user and find myself using help foo constantly and learning a ton from the examples. However, discoverability is still an issue for me. When I realize that enter is the way to "pushd", I have no idea that shells is the way to see them (traditional "dirs"). It'd be really helpful if there was some cross-referencing in the help outputs, probably below the Examples: section.
I would be up for trying (a PR) to add a bunch of See also: sections to the commands references (.md). But want to make sure you folks are on board with the idea before putting time into it.
The motivation for this is what's seen in the Clojure docs (similar to how a single web doc resource is exported into editor tooling (cider etc)): https://clojuredocs.org/clojure.core/reduce
The "SEE ALSO" section there near the bottom (and on all the similar docs) is very useful.
- Linguagem predominante
- TypeScript
- Estrelas
- 262
- Forks
- 562
- Merge médio
- 3h 51min
- PRs com merge (30d)
- 15
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
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 nushell/nushell.github.io
-
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 68/100
nushell/nushell.github.io#2081 · 3 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 62/100
nushell/nushell.github.io#767 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 58/100
nushell/nushell.github.io#2232 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 58/100
nushell/nushell.github.io#2209 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 45/100
nushell/nushell.github.io#2194 ·
Mantenedores costumam responder em até 1 dia
Todas as issues de nushell/nushell.github.io
Issues semelhantes
-
documentation good first issue
Dificuldade 2/5 Meio dia Facilidade para iniciantes 72/100
sujithputta02/Esapay#13 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
ehmpathy/rhachet-roles-bhuild#468 ·
Mantenedores costumam responder em até 1 dia
-
Share dialog: the address book's contact count reads "1 contacts" (no singular form in any language)Talvez já em andamento @chibenwa assumiu hoje. Abertaai-driven-qa bug claude Cosmetic
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
linagora/twake-contacts-frontend#271 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
factory-active task-identify-harness-labels-done task-identify-issue-type-done
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 70/100
vercel/ai#23435 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Koenkk/zigbee2mqtt#33402 ·
Mantenedores costumam responder em até 1 dia