Redocly / Redocly/create-openapi-repo
Improve README
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 695
- Forks
- 111
- PR merge metrics
- No merged PRs in 30d
Description
Improve the README.
Maybe we should specifically explain two use-cases:
- split an existing OpenAPI definition
- start a new OpenAPI definition
And then better explain the structure of the resulting split repository?
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 by reading the existing README and identify where it describes the project workflow. Update it to explain splitting an existing OpenAPI definition, starting a new OpenAPI definition, and the structure of the resulting split repository. Done means all three topics are clearly covered in the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100