racket / racket/web-server

Revamp "Continue: Web Applications in Racket"

Open
#131 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Racket
Stars
99
Forks
48
PR merge metrics
No merged PRs in 30d

Description

Here's a list of improvements that I wish to see:

Better spacing

The following image shows one of the issues.

Screenshot 2023-11-11 at 9 58 58 AM

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.