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

Added Objects Documentation #114

Closed
wants to merge 2 commits into from
Closed

Added Objects Documentation #114

wants to merge 2 commits into from

Conversation

ControlCplusControlV
Copy link

@salazarguille want to make sure this a good layout before doing the rest of the objects. Is there a specific format besides laying out each field and what datatype it returns, as well as a 1 to 2 sentence description of what the value represents for each field? What changes would like you me to make or is there another piece of documentation you would like me working on?

Began work on a md file to document all of the objects the subgraph can return as well as the various fields they have. Hoping to lay out a format for each object before doing them all as well as what areas should be expanded upon
@salazarguille salazarguille linked an issue Nov 18, 2021 that may be closed by this pull request
@salazarguille
Copy link

Hey @ControlCplusControlV thank you very much for your contribution!!

I guess you are working on the #97 Right?

The output for that issue is to improve the field and entity descriptions.

The field descriptions can be added in the schema file directly, so users can see the descriptions in The
Graph website. Each field has a brief description (but sometimes the description doesn't say anything). So, we can improve them.

Also, there is a new doc here with some descriptions for the entities. Feel free to improve the description or add any section that you think is pending.

To sum up:
Fields in the schema.graphql file.
Entities in the onboarding.md file.

@rareweasel
Copy link

Hey @ControlCplusControlV do you need help with the @salazarguille comment?

@ControlCplusControlV
Copy link
Author

@rareweasel Been busy, but expecting to get to go through schema documentation today

@ControlCplusControlV
Copy link
Author

@salazarguille would you prefer if I close this PR, and then on a fresh fork with just my improve comments on schema.graphql make a new PR with just that change?

@salazarguille
Copy link

@salazarguille would you prefer if I close this PR, and then on a fresh fork with just my improve comments on schema.graphql make a new PR with just that change?

Hey @ControlCplusControlV as you feel more comfortable. You already know the output for this task, so you can decide. I guess some PRs were merged, so try to get the latest changes in your branch.

Please, then let @rareweasel know when it is ready for review. @rareweasel will help us with the reviews in the subgraph.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add More Docs About Entities & Handlers
3 participants