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.

Sign up for GitHub

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

Jump to bottom

feat: add subgraph documentation #1013

Closed
wants to merge 42 commits into from
Closed

feat: add subgraph documentation #1013

wants to merge 42 commits into from

Conversation

PaulieB14
Copy link

@PaulieB14 PaulieB14 commented Dec 13, 2022 •
edited by MantisClone
Loading

Closes #1017

Added subgraph documentation with information, links, entities, and subgraph query examples. Do I have to add anything to Docusaurus.config?

MantisClone
MantisClone requested changes Dec 14, 2022
View reviewed changes
Copy link
Member

@MantisClone MantisClone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for submitting this PR!

I requested changes on RequestNetwork/payments-subgraph#45. Please update this PR once the changes are made.

@PaulieB14
Copy link
Author

@MantisClone sure thing. I was having trouble matching prettier settings on this and getting errors.

@MantisClone
Copy link
Member

@PaulieB14 Would you mind also documenting our other two subgraphs:

@PaulieB14
Copy link
Author

@MantisClone sure I can document the other two as well. I will make revisions to this once the Schema is completed

@PaulieB14
Copy link
Author

PaulieB14 commented Dec 15, 2022 •
edited
Loading

@MantisClone the other two subgraphs don’t seem deployed yet. I can certainly add docs for their entities if you'd like. Let me know

@MantisClone
Copy link
Member

@PaulieB14
The storage subgraphs are deployed on internal graph nodes. They are private for now. The reason why we need our own nodes is that they are using our own "private" IPFS network.

The price aggregator subgraphs can be found here:

@MantisClone
Copy link
Member

@MantisClone sure thing. I was having trouble matching prettier settings on this and getting errors.

husky runs prettier before each commit. You can install it by running yarn install in the repo root.

MantisClone
MantisClone requested changes Dec 20, 2022
View reviewed changes
packages/docs/docs/guides/8-request payment subgraph/0-subgraph-info.md Outdated Show resolved Hide resolved
.husky/pre-commit Outdated Show resolved Hide resolved
packages/docs/docs/guides/10-request price aggregators subgraph/1-entities-aggregator.md Outdated Show resolved Hide resolved
packages/docs/package.json Outdated Show resolved Hide resolved
@MantisClone MantisClone self-requested a review December 21, 2022 15:21
MantisClone
MantisClone requested changes Dec 21, 2022
View reviewed changes
Copy link
Member

@MantisClone MantisClone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work @PaulieB14 I left some change requests.

.husky/pre-commit Outdated Show resolved Hide resolved
packages/docs/docs/guides/11-glossary.md Outdated Show resolved Hide resolved
packages/docs/docs/guides/8-request payment subgraph/1-entities.md Outdated Show resolved Hide resolved
packages/docs/docs/guides/8-request payment subgraph/1-entities.md Outdated Show resolved Hide resolved
packages/docs/docs/guides/8-request payment subgraph/1-entities.md Outdated Show resolved Hide resolved
packages/docs/docs/guides/9-request storage subgraph/0-entities-storage.md Outdated Show resolved Hide resolved
packages/docs/docs/guides/9-request storage subgraph/0-entities-storage.md Outdated Show resolved Hide resolved
packages/docs/docs/guides/9-request storage subgraph/0-entities-storage.md Outdated Show resolved Hide resolved
packages/docs/docs/guides/9-request storage subgraph/0-entities-storage.md Outdated Show resolved Hide resolved
packages/docs/docs/guides/9-request storage subgraph/0-entities-storage.md Outdated Show resolved Hide resolved
@PaulieB14
Update 1-entities.md
71c52e8 
Changed descriptions to match corrected Schema
@PaulieB14
Update pre-commit
cd6609b 
Removed line 5
@MantisClone MantisClone changed the title Added subgraph documentation feat: add subgraph documentation Dec 23, 2022
@MantisClone MantisClone self-requested a review December 23, 2022 01:33
@PaulieB14 PaulieB14 deleted the branch RequestNetwork:master December 23, 2022 01:52
@PaulieB14 PaulieB14 closed this Dec 23, 2022
@PaulieB14 PaulieB14 deleted the master branch December 23, 2022 01:52
This was referenced Dec 23, 2022
Merged
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MantisClone MantisClone Awaiting requested review from MantisClone

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

As a Builder, I want a Subgraph Reference, so I can understand how to use RN's Subgraphs.
2 participants
@PaulieB14 @MantisClone