Redocly / Redocly/create-openapi-repo
Update Readme
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 695
- Forks
- 111
- PR merge metrics
- No merged PRs in 30d
Description
This repo is outdated. We would recommend someone use the OpenAPI starter repo instead and use Redocly CLI which has some special commands which served similar purposes but they are actually way better:
split: it will split into OpenAPI spec-compliant multi-files.bundle: to pull it back together into one filelint: to keep OpenAPI correct and to extend with your own rules- more commands to explore too
Contributor guide
No contributing guide indexed for this repository
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 repository README and compare its current guidance with the OpenAPI starter repo and Redocly CLI named in the issue. Update the README to recommend the newer approach and summarize the listed split, bundle, and lint commands; done means the outdated workflow is clearly replaced.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100