Question: organization of documentation

Aperta
#355 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

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

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di orientechnologies/orientdb-docs

Tutte le issue di orientechnologies/orientdb-docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.