ruby / ruby/docs.ruby-lang.org
Generate all Ruby versions' documentation with the latest (released) RDoc
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Ruby
- Sterne
- 53
- Forks
- 27
- Ø Merge
- 1 Std. 39 Min.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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 🙂
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Vergleiche die Master-Dokumentation unter docs.ruby-lang.org/en/master/index.html mit der versionierten Dokumentation für Ruby 3.3 und frühere Versionen, um die Unterschiede bei der Generierung zu ermitteln. Untersuche anschließend die Einstiegspunkte für die Dokumentationsgenerierung in diesem Repository und bestimme, wie das neueste veröffentlichte RDoc auf die unterstützten Ruby-Versionen angewendet werden kann; abgeschlossen ist die Aufgabe, wenn die versionierten Websites die angeforderten Verbesserungen an Theme und SEO enthalten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- ruby
- Bereich
- build-system, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100