create a readthedocs page
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Ambito
- documentation
Direzione di ricerca
Inizia esaminando il README attuale e l’approccio proposto con Sphinx e ReadTheDocs. Definisci pagine separate per la guida per l’utente, le FAQ, i dettagli di implementazione e le specifiche della grammatica, lasciando il README come una breve introduzione con un esempio di avvio rapido e link alla documentazione aggiuntiva.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Good suggestion from one of our SoftwareX reviewers:
I suggest creating a documentation website using an option like Sphinx and ReadTheDocs.org, which provides free hosting, or using a wiki on GitHub. The Sphinx + RTD option is nicer and more flexible, but takes more setup. In either case, the main benefit would be having separate pages that could split out things like user guide, FAQ, implementation details, and grammar specifications. For the README file, I suggest just having a brief introduction and a quick example of using Davos to get people started, with those two things taking up a about a page. A link to an FAQ section can still be included to refer skeptical readers, but I think the pitch in the README can be very simple and focused on the benefits of Davos, rather than trying to contrast with all the other available systems. The quick start section can show simple examples to help play up a strength of Davos, which is that most users will need to read very little documentation to get started.
- Lingua principale
- TeX
- Stelle
- 37
- Fork
- 8
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
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 ContextLab/davos
-
documentation enhancement good first issue help wanted
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
ContextLab/davos#116 ·
-
Add Windows supportForse di nuovo libera @paxtonfitzpatrick l’ha presa 1111 giorni fa e non c’è nessuna pull request aperta. Apertaenhancement
ContextLab/davos#113 · 7 commenti · 1 reazione · 1 assegnatario ·
-
enhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
ContextLab/davos#105 · 1 commento ·
-
enhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
ContextLab/davos#100 ·
-
enhancement
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
ContextLab/davos#99 · 1 commento ·
Tutte le issue di ContextLab/davos
Issue simili
-
documentation good first issue help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 90/100
eugenioenko/ttt#1000 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation v2
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
modelcontextprotocol/servers#5170 ·
I maintainer di solito rispondono entro 1 giorno
-
Lychee link check failedAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
SwiftKickMobile/skai#83 ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 86/100
I maintainer di solito rispondono entro 1 giorno