loopbackio / loopbackio/loopback-next
[Docs] Example config.json for `lb4 <command>` except `lb4 app` shows the app-config.json
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.1k
- Forks
- 1.1k
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 27
Description
Description / Steps to reproduce / Feature proposal
In the CLI generator docs e.g. https://loopback.io/doc/en/lb4/Model-generator.html, the example --config option shows the lb4 app example. This is true for Application, Datasource, Repository, etc. generators (7 generators in total).
Expected Behavior
We should show the appropriate config json file that the commands are expecting. Find a dynamic way to update https://github.com/strongloop/loopback-next/blob/master/docs/site/includes/CLI-std-options.md for each command.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/site/includes/CLI-std-options.md and compare its --config example with the CLI generator documentation, including the seven generators named in the issue. Determine how each command’s expected config JSON is represented, then update the documentation so every command shows the appropriate example and verify the affected generator pages.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100