infra
infra copied to clipboard
improve(website): api references
Summary
Basic implementation of API docs using @stoplightio/elements
. Pulls versioned openapi spec directly from github which probably isn't the smartest solution.
TODO
- [x] Use spec file from the repo
- [x] Dynamically route to discovered API versions
- [ ] Add right hand nav to switch between versions
- [ ] Add left hand nav for other available docs
Checklist
- [ ] Wrote appropriate unit tests
- [ ] Considered security implications of the change
- [ ] Updated associated docs where necessary
- [ ] Updated associated configuration where necessary
- [ ] Change is backwards compatible if it needs to be (user can upgrade without manual steps?)
- [ ] Nothing sensitive logged
- [ ] Considered data migrations for smooth upgrades
Related Issues
Resolves #2427
how does this look when rendered?
It's far from complete but you can get a preview here
Very cool start. Excited to see where this goes
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
Closing for now