wpengine / wpengine/hwptoolkit
docs[tutorial]: Making a GraphQL Request (POST/GET basics, fetch)
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 47
- Forks
- 3
- Avg merge
- 1m
- Merged PRs (30d)
- 19
Description
User Story
As a toolkit user, I want to do a tutorial on POST/GET basics with fetch, in order to optimize performance for my project.
Acceptance Criteria
- A public tutorial POST/GET basics using fetch
- Succinctly teaches when and why to use POST
- Succinctly teaches when and why to use GET
Notes
Existing explanation: https://github.com/wpengine/hwptoolkit/blob/main/docs/explanation/get-vs-post.md
This should live in https://github.com/wpengine/hwptoolkit/tree/main/docs, in a tutorial directory if one doesn't exist yet.
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 with docs/explanation/get-vs-post.md and inspect the existing docs structure under docs, creating or using a tutorial location as appropriate. Write a public tutorial covering POST/GET basics with fetch, including when and why to use each method. Done means the tutorial is succinct and satisfies all three acceptance criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100