ruby / ruby/docs.ruby-lang.org

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

Aperta
#153 0 commenti 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Ruby
Stelle
53
Fork
27
Merge medio
1h 39m
PR unite (30g)
2

Descrizione

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 🙂

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Confronta la documentazione master all'indirizzo docs.ruby-lang.org/en/master/index.html con la documentazione versionata di Ruby 3.3 e precedenti per identificare le differenze di generazione. Quindi esamina i punti di ingresso per la generazione della documentazione in questo repository e determina come applicare l'ultimo RDoc rilasciato alle versioni di Ruby supportate; il lavoro è completo quando i siti versionati contengono i miglioramenti richiesti per theme e SEO.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
ruby
Ambito
build-system, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.