Redocly / Redocly/openapi-starter
Improve code samples instructions
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 220
- Forks
- 133
- PR merge metrics
- No merged PRs in 30d
Description
There are some simple instructions for adding code samples in the last section of the README, but they are quite short and don't explain why code samples are useful. Try the feature for yourself, and then expand the instructions and include the examples for someone else to use.
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 last section of the README and try the code-sample feature yourself to understand the current instructions. Expand that section with why code samples are useful and examples that another user can follow; done means the README gives clear, usable guidance for adding code samples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100