[Proposal] Add user guide, especially about directives
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 25/100
- Tipo de issue
- Documentação
- Clareza
- Precisa de esclarecimento
- Status de atividade
- Estagnada
- Stack de tecnologia
- ruby
- Domínio
- documentation
Direção de pesquisa
Comece revisando o guia japonês de RDoc vinculado na issue, especialmente a cobertura de diretivas. Defina o escopo de um guia de usuário em inglês que cubra diretivas e outros recursos do RDoc e, em seguida, traduza e organize esse material para que ele se torne uma única referência para usuários e desenvolvedores.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
I noticed that there's no list for directives. In fact, there's not a comprehensive user guide in English (the only I found was in Japanese: https://docs.ruby-lang.org/ja/latest/library/rdoc.html).
Adding user guide has two purposes. First, of course, users will refer to the guide so that they can use directives and other features of RDoc more effectively. Second, it will be a single source of truth for RDoc behavior so developers can rely on it.
I suggest the first version of the guide could be a direct translation of the Japanese guide mentioned above since we don't have to talk about what should be in the guide.
Any thoughts?
- Linguagem predominante
- Ruby
- Estrelas
- 930
- Forks
- 472
- Merge médio
- 2d 8h
- PRs com merge (30d)
- 12
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 ruby/rdoc
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Mantenedores costumam responder em até 1 dia
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationTalvez já em andamento @OskarEichler assumiu há 80 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
ruby/rdoc#1759 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
markdown html excerpt includes link partsTalvez já em andamento @anyingiit assumiu há 26 dias. Aberta
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 66/100
Mantenedores costumam responder em até 1 dia
-
Regexp generated from unescaped input in #expand_classTalvez já em andamento @jaynetics assumiu há 39 dias. Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 25/100
Mantenedores costumam responder em até 1 dia
Issues semelhantes
-
Pro request form loses all text when the subject is too longTalvez já em andamento Um pull request vinculado a esta issue está aberto ou já foi mesclado. Abertabug f:request-creation professional
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
mysociety/alaveteli#9733 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
needs verification
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
Mantenedores costumam responder em até 13 dias
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
betagouv/conseillers-entreprises#4808 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100