Improve OpenAPI (REST) documentation for the website with a docusaurus plugin
- Dominant language
- TypeScript
- Stars
- 270
- Forks
- 193
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 36
Description
The App Directory documentation uses a generated ReDoc static html file for the API docs, based on appd.yaml, but docusaurus now have several nice plugins for integrating OpenAPI documentation which we should incorporate.
One of them is https://github.com/cloud-annotations/docusaurus-openapi (example: https://docusaurus-openapi.netlify.app/).
The other is https://github.com/rohit-gohri/redocusaurus (example: https://redocusaurus.vercel.app/).
Contributor guide
Research direction
Start by examining the App Directory documentation's generated ReDoc static HTML and appd.yaml. Compare the two linked Docusaurus OpenAPI integrations and determine which fits the website. Done means the API documentation is integrated through the selected plugin rather than the generated static file.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100