Question: organization of documentation
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
- javascript
- Ambito
- documentation
Direzione di ricerca
L’issue cita la documentazione di orientjs, la documentazione del driver e i commenti in stile JSDoc, ma non indica file o test. Inizia individuando queste aree della documentazione e chiarisci se la documentazione versionata locale al repository e le firme generate rientrano nell’ambito; il lavoro sarebbe completo una volta concordati un layout della documentazione e un approccio alla generazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Is there a reason why the docs are store separately from the codebase?
Would you consider storing the docs for each repo with the code itself? At least for the drivers? It would be easier to tell what code works for what version then. In particular, this is currently a bit difficult when using the orientjs docs.
It would also be nice to have jsdoc style comments that could auto-generate docs. Then it would be easier to see function signatures etc.
If this is something you'd like to do I would be happy to help/contribute
- Lingua principale
- CSS
- Stelle
- 59
- Fork
- 164
- 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 orientechnologies/orientdb-docs
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 48/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 50/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 25/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
orientechnologies/orientdb-docs#387 · 1 commento ·
Tutte le issue di orientechnologies/orientdb-docs
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
ethereum/execution-apis#1017 ·
I maintainer di solito rispondono entro 3 giorni
-
[Docs] CONTRIBUTING points the Backend Remake milestone at a branch that does not existForse già presa @franpts2 l’ha presa oggi. Apertadocs
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
I maintainer di solito rispondono entro 3 giorni
-
postgresql-rules / queue-rules: implicit KEY SHARE before a parent key update, and job self-overlapAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
jonathanong/no-mistakes#3879 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
pearu/agent-sandbox#451 ·
I maintainer di solito rispondono entro 1 giorno