Feat: Docusaurus build in execution-apis #725
Open
Conversation
This file contains hidden or 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
This change migrates the build from gatsby to docusaurus. The build was growing rusty and was blocking serious devex improvements. This change enables, documentation search, fork/eip/category tagging, support for error groups, copying as markdown, and standardized docusaurus support. The build also writes documentation do a documentation folder as a commit this changes the previous method, while it does add a small amount of incremental noise, it improves the devex, as you can pinpoint rendering/typo issues etc.. more directly and link to them. One thing to note is that the documentation is auto generated and should not be edited directly.
Contributor
Author
|
@lightclient @kclowes PTAL , just pinging you here as well :) |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR fixes #724 . The PR is broken into two segments for ease of readability, and will be squashed into a single commit once approved.
The PR introduces docusaurus instead of Gatsby, and subsequently introduces commitment of docs directly into the build. Just past this initial commit, most documentation changes should be minimal, and should improve visibility and testing, as they'll be mostly visible directly from the PRs.
The second commit here is to add the generated documentation to the build. If running locally, the engine index will not show the search documents.
Here is a forked build that shows the PR live that can be hit to demonstrate as preview of this build:
https://createdreamtech.github.io/execution-apis/