loopbackio / loopbackio/loopback-next
CLI docs: unify reference guides and `lb4 --help`
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 5.1k
- Forks
- 1.1k
- Ø Merge
- 2 T. 21 Std.
- Gemergte PRs (30 T.)
- 27
Beschreibung
At the moment, we have two different content describing CLI commands:
lb4 {command} --helpprints 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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Vergleiche die CLI Reference-Seiten mit der Ausgabe von lb4 {command} --help, beginnend mit dem dokumentierten DataSource-Generator und den aktuellen Help-Einstiegspunkten. Definiere eine einzige Markdown-basierte Quelle und überprüfe, dass sowohl die Referenzleitfäden als auch die Terminalhilfe sie verwenden; die Abnahmekriterien müssen noch festgelegt werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- nodejs, typescript
- Bereich
- cli, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100