[Proposal] Add user guide, especially about directives

Aberta
#1,119 3 comentários 0 reações 0 responsáveis Ver no GitHub

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

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de ruby/rdoc

Todas as issues de ruby/rdoc

Issues semelhantes

Mais issues de Ruby

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.