documentationjs / documentationjs/documentation
Make documentation syntax more visible?
- Lingua principale
- JavaScript
- Stelle
- 5.8k
- Fork
- 481
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
I feel this project could benefit to having the syntax that developers should use more visibly presented. Right now it's hidden away in the [Getting Started](https://github.com/documentationjs/documentation/blob/master/docs/GETTING_STARTED.md) file. I would propose:
- Move the syntax documentation (along with #268, if accepted) to a section in the main README. It doesn't need to contain the whole contents of Getting Started, just a short example that can be used to get started quickly.
- Add this syntax documentation to [the website](http://documentation.js.org/) as well (or maybe just mirror the full contents of the README).
Thoughts?
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia leggendo docs/GETTING_STARTED.md e il README attuale per identificare il materiale sulla sintassi che dovrebbe essere reso visibile. Poi esamina il punto di ingresso del sito web documentation.js.org, che non è nominato nell’issue, e determina come il README o un esempio abbreviato possano essere riportati lì. Il lavoro è completo quando la sintassi è individuabile dal README e dal sito web senza richiedere il documento Getting Started completo.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100