graphprotocol / graphprotocol/docs
Provide better documentation on the `--skip-migrations` flag
Open
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 85
- Forks
- 162
- Avg merge
- 6h 31m
- Merged PRs (30d)
- 4
Description
I searched for hours to no avail, until I had to clone the CLI repo to understand what the flag did. Considering "migrations" is a very loaded term, this should be well documented IMO
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
Start by inspecting the CLI repository to determine what the --skip-migrations flag does and which migration process it affects. Update the documentation so the flag's behavior and the meaning of “migrations” are clear, then verify that the relevant CLI documentation explains when the option should be used.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100