Document the difference between `redoc`, `redoc-cli`, and `@redocly/cli` packages
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.5k
- Forks
- 228
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 48
Description
I'm a new user reading the documentation for the first time. I don't understand the relationship between
Are some of these deprecated? redoc says it can "Generate interactive API documentation from OpenAPI definitions", but so can npx @redocly/cli build-docs. However, I don't see any build-docs command on this page: https://redocly.com/docs/cli/commands/
Which should I use to generate html documentation from openapi spec?
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 the linked documentation pages and the npm pages for redoc, redoc-cli, and @redocly/cli. Verify how the packages relate, whether any are deprecated, and where the HTML-generation command is documented. Done means the documentation clearly explains which package and command a new user should use to generate HTML from an OpenAPI specification.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100