DVP-27, DVP-28, DVP-29: Autogenerate api references using starlight openapi plugin,migrate overview page with playgrounds #187
+1,125
−866
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iskysun96
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ℹ Overview
This PR addresses tickets DVP-26, DVP-27, DVP- 28, DVP-29.
I used the starlight openapi plugin to autogenerate the API reference docs.
The Starlight open API plugin auto-detects tags and autogenerates multiple pages where each page is divided by tags and headers. Is this what we want, or do we want to create a single algod API reference page like our old devportal? @larkiny @SilentRhetoric
I also migrated the overview page with interactive playgrounds (postman, Nodely's swagger page)
📝 Related Issues
resolve DVP-26, DVP-27, DVP- 28, DVP-29
✅ Acceptance: