ruby / ruby/docs.ruby-lang.org

Generate all Ruby versions' documentation with the latest (released) RDoc

Aberta
#153 0 comentários 4 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
Ruby
Estrelas
53
Forks
27
Merge médio
1h 39min
PRs com merge (30d)
2

Descrição

I recently made quite a few theme improvements to RDoc, along with community contributed changes like SEO tags...etc., which are all applied to the master documentation (https://docs.ruby-lang.org/en/master/index.html).
But since most of users will still be using Ruby 3.3 and prior versions for years to come, I think it'd be better if we can apply the same changes to their documentation too. I'd appreciate some pointers or even collaborations to make that happen. Thank you 🙂

Guia de contribuição

Abrir o guia de contribuição

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.

Direção de pesquisa

Compare a documentação master em docs.ruby-lang.org/en/master/index.html com a documentação versionada do Ruby 3.3 e anteriores para identificar as diferenças de geração. Em seguida, inspecione os pontos de entrada da geração de documentação deste repositório e determine como o RDoc lançado mais recentemente pode ser aplicado às versões do Ruby compatíveis; considera-se concluído quando os sites versionados contiverem as melhorias solicitadas de theme e SEO.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
ruby
Domínio
build-system, documentation
Tipo de issue
Documentação
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

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