graphprotocol / graphprotocol/docs
Various issues I found while proofreading docs
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 85
- Forks
- 162
- Avg merge
- 6h 31m
- Merged PRs (30d)
- 4
Description
Tilde misuse in subgraphs > querying > best practices?
Found in subgraphs > querying > graph client > introduction:
missing link?
Not sure what is off about this sentence:
Tilde problems:
Found in subgraphs > querying > graph client > architecture:
'Everything apps need' or 'everything your app needs'?
change 'then' to 'that' or is a word missing -- I wasn't sure:
allow you to connect?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the pages under Subgraphs > Querying > Best practices and Graph Client > Introduction and Architecture, using the attached screenshots to locate each proofreading issue. Done means correcting the reported tilde usage, missing link or wording, and confirming the affected documentation reads consistently.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100