loopbackio / loopbackio/loopback-next

CLI docs: unify reference guides and `lb4 --help`

Aperta
#5,774 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

CLI Docs feature help wanted
Lingua principale
TypeScript
Stelle
5.1k
Fork
1.1k
Merge medio
2g 21h
PR unite (30g)
27

Descrizione

At the moment, we have two different content describing CLI commands:

  • lb4 {command} --help prints content generated by Yeoman based on generator arguments and options
  • Hand-written documentation pages in CLI Reference section, e.g. DataSource generator

It would be great to unify these two kinds of resources into a single source. (This idea was originally mentioned by @raymondfeng.)

For example, we can maintain CLI help in Markdown format and use a module like marked-terminal to allow lb4 --help to render the documentation to terminal. (Tangentially related: Get rid of Yeoman #844)

This story is a part of #5113 Documentation improvements 2020Q3

Acceptance criteria

TBD - will be filled by the team.

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Confronta le pagine di CLI Reference con l’output di lb4 {command} --help, iniziando dal generatore DataSource documentato e dagli attuali punti di accesso all’help. Definisci un’unica fonte basata su Markdown e verifica che la utilizzino sia le guide di riferimento sia l’help del terminale; i criteri di accettazione devono ancora essere stabiliti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
nodejs, typescript
Ambito
cli, documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.