[Proposal] Add user guide, especially about directives
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- ruby
- Ambito
- documentation
Direzione di ricerca
Iniziate esaminando la guida giapponese di RDoc collegata nell’issue, in particolare la trattazione delle direttive. Definite l’ambito di una guida utente in inglese che copra le direttive e le altre funzionalità di RDoc, quindi traducete e organizzate quel materiale in modo che diventi un’unica risorsa di riferimento per utenti e sviluppatori.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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?
- Lingua principale
- Ruby
- Stelle
- 930
- Fork
- 472
- Merge medio
- 2g 8h
- PR unite (30g)
- 12
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di ruby/rdoc
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationForse già presa @OskarEichler l’ha presa 80 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
I maintainer di solito rispondono entro 1 giorno
-
markdown html excerpt includes link partsForse già presa @anyingiit l’ha presa 26 giorni fa. Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 66/100
I maintainer di solito rispondono entro 1 giorno
-
Regexp generated from unescaped input in #expand_classForse già presa @jaynetics l’ha presa 39 giorni fa. Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 25/100
I maintainer di solito rispondono entro 1 giorno
Issue simili
-
bug f:request-creation professional
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
mysociety/alaveteli#9733 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
needs verification
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
I maintainer di solito rispondono entro 13 giorni
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
betagouv/conseillers-entreprises#4808 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100