Make it easy for developers to construct code/commands on HTTP header related pages
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 233
- Forks
- 61
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
Navigating the HTTP docs while investigating what OPTIONS does (in the context of a CORS preflight request) made me want to be able to copy a request code block as a curl command so I could easily run it locally without having to construct it myself.
Implementation could be a little tricky - there would be a load of edge cases and we'd need some sort of allow-list to figure out which code blocks are requests rather than responses - but perhaps we could hard code a button on our most popular HTTP page as an experiment, and see how many people actually click on it.
That implementation could also be useful if we wanted to integrate with the devtools network panel (where you can craft requests in a GUI).
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 locating the HTTP documentation pages and their request code blocks, especially the page covering OPTIONS and CORS preflight requests. Assess how an experiment on a popular HTTP page could identify request blocks and expose a curl-copy action. Done means the scope, request allow-list, edge cases, and success measure for the experiment are agreed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, frontend, web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100