Revamp "Continue: Web Applications in Racket"
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by locating the “Continue: Web Applications in Racket” tutorial and reviewing the sections using #lang web-server/insta. Address the listed spacing, contract, tag, link, naming, and argument-name inconsistencies; done means the tutorial is visually consistent, links work, and its terminology is internally consistent.
Written by the indexing model from the issue text.
Description
Here's a list of improvements that I wish to see:
Better spacing
The following image shows one of the issues.
There's too much space before the box, and not enough space after the box.
Consistent usage of contract
There's a weird mix of HtDP-style signature and actual Racket contract throughout the tutorial, which is confusing. We should pick one style and use it consistently.
Slightly off-topic, but while I know that the tutorial's target audience is readers of the first edition of HtDP, I'm not sure if that makes sense anymore.
Use appropriate tags
Several @tt should have been @litchar.
Linkify code
All links under #lang web-server/insta are broken.
Consistent naming
Right now, functions whose name is prefixed with render- are used in two different ways: they might return an xexp/c or a response?. It would be nice to make things consistent. Perhaps make-XXX-request for functions that return response? and render-XXX for functions that return xexpr/c?
Avoid "request" as an argument name.
This is to avoid incorrect linkified text.
- Dominant language
- Racket
- Stars
- 100
- Forks
- 48
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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.
More from racket/web-server
-
Difficulty 1/5 Under an hour Newbie friendliness 70/100
racket/web-server#46 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
racket/web-server#141 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
racket/web-server#140 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
racket/web-server#135 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
racket/web-server#127 ·
All issues in racket/web-server
Similar issues
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
agilepathway/label-checker#640 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
BasedHardware/omi#15662 · 1 comment ·
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100