Skip to content
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
merged 8 commits into from
Apr 2, 2024

Conversation

banasa44
Copy link
Contributor

@banasa44 banasa44 commented Mar 15, 2024

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

  • New feature (non-breaking change which adds functionality)

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran all tests with success and extended them if necessary.
  • I have updated the CHANGELOG.md file in the root folder.
  • I have updated the DEPLOYMENT_CHECKLIST file in the root folder.
  • I have updated the UPDATE_CHECKLIST file in the root folder.

.gitignore Outdated Show resolved Hide resolved
@banasa44 banasa44 requested a review from Rekard0 March 25, 2024 16:34
Copy link
Contributor

@heueristik heueristik left a 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.

.github/workflows/subgraph-documentation-update.yml Outdated Show resolved Hide resolved
packages/subgraph/package.json Outdated Show resolved Hide resolved
heueristik
heueristik previously approved these changes Mar 27, 2024
@banasa44 banasa44 merged commit cd65ae1 into develop Apr 2, 2024
17 checks passed
@banasa44 banasa44 deleted the feature/update-subgraph-DevPortal-docs-flow branch April 2, 2024 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants