Support code examples in info description?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Thanks for all your hard work on this project! It's very impressive.
What would you think about adding either a vendor extension or an include (similar to ReDoc-Inject to allow code examples (ie examples in the right hand column) in the description attribute of the top level info?
DigitalOcean's docs do this and it's quite handy:
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 by locating the renderer for the top-level OpenAPI info.description and checking how ReDoc handles includes or vendor extensions; use the linked ReDoc-Inject example as a reference. Done means a documented approach lets descriptions contain code examples that render in the right-hand column without breaking existing descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100