-
Notifications
You must be signed in to change notification settings - Fork 43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create flow to update subgraph docs on Dev-Portal #557
Merged
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
Rekard0
reviewed
Mar 25, 2024
Rekard0
reviewed
Mar 25, 2024
Rekard0
reviewed
Mar 25, 2024
Rekard0
reviewed
Mar 25, 2024
Co-authored-by: Rekard0 <[email protected]>
heueristik
suggested changes
Mar 26, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's make sure that the workflow does not run on closing a PR.
If this was adapted from the SDK workflows, let's make sure to fix it there as well.
heueristik
previously approved these changes
Mar 27, 2024
Rekard0
approved these changes
Apr 2, 2024
heueristik
approved these changes
Apr 2, 2024
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.
Description
This PR introduces everything needed to generate Subgraph documentation and send it to the Developer-Portal. It mimics the workflows on SDK and OSX/contracts.
It doesn't generate all the subraph documentation as the reference-guide documentation is generated in the Dev-Portal itself as we are using a plugin from Docusaurus that generates it. What we are providing though is the result of the introspection query needed to generate the subgraph docs.
The PR includes 2 query example samples as this will be the actual workflow, the test for these queries will be done in following-up tasks.
Task ID: OS-1051
Type of change
Checklist:
CHANGELOG.md
file in the root folder.DEPLOYMENT_CHECKLIST
file in the root folder.UPDATE_CHECKLIST
file in the root folder.