[Proposal] Add user guide, especially about directives

Offen
#1,119 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Dokumentation
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
ruby
Bereich
documentation

Rechercherichtung

Beginnen Sie mit der Durchsicht des im Issue verlinkten japanischen RDoc-Leitfadens, insbesondere seiner Behandlung von Direktiven. Legen Sie den Umfang eines englischen Benutzerleitfadens fest, der Direktiven und andere RDoc-Funktionen abdeckt, und übersetzen und organisieren Sie dieses Material so, dass es zu einer einzigen Referenz für Benutzer und Entwickler wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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?

Vorherrschende Sprache
Ruby
Sterne
930
Forks
472
Ø Merge
2 T. 8 Std.
Gemergte PRs (30 T.)
12

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus ruby/rdoc

Alle Issues in ruby/rdoc

Ähnliche Issues

Weitere Issues zu Ruby

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.