Make `redocly split --outDir` easier to understand
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.5k
- Forks
- 228
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 48
Description
Is your feature request related to a problem? Please describe.
When using the split command, the output directory --outDir should be specified and that isn't always very clear.
Describe the solution you'd like
make this more obvious in the documentation, CLI help, and when running the command itself (send a hint to stderr perhaps).
Describe alternatives you've considered
Changing the command signature for all users. Which, just after a major release where we intentionally reduced the number of positional arguments in our commands, does not seem appealing
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 at the redocly split command implementation and its documentation and CLI-help entry points; compare how --outDir is described and how the command runs. Update the documentation, help text, and runtime stderr guidance so the output-directory requirement is obvious, then verify the split command presents the guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100