Welcome to the Graph Protocol! Thanks so much for helping us improve our documentation. Any contribution to this project, when it’s approved and merged, will eventually be visible on https://thegraph.com/docs.
Please read and follow our Code of Conduct to keep our community approachable and respectable.
Most of our docs are written in Markdown. If you are not familiar with Markdown, learn more here. The files that you’ll likely be updating are inside of the “pages” folder. From there select a language in order to view the Markdown files.
Direct contributions are much appreciated for simple things (corrections, small additions to existing content). If the change is more complex, we encourage you to start a discussion in GitHub Issues or Discord first.
Change proposals should only be made to the English language version of pages (under /pages/en/), as translations are handled by Crowdin. If you spot an issue with a translation, please do open an issue to let us know!
Once you located the file that you want to update, click on “Edit” which will create a new forked repo. You can make your edits there, and submit a PR. Alternatively, you can manually fork the repo, create a branch in your fork and make all the edits you want before submitting a PR.
Tag graphprotocol/docs-reviewers in your PR to get the reviewers’ attention. Once we review it, we’ll likely provide feedback and might ask you for improvements. Once the review process is finalized and at least 2 people approve, the PR will be merged. We aim to provide a meaningful response to all PRs and issues from external contributors within 5 business days.
You can optionally run the application locally to review your changes.
If you would like to report a bug, or propose a larger feature, please create an issue. Before doing so, please search existing issues for relevant keywords, in case your issue has already been raised by someone else.