solid / solid/specification

Making HTTP refs more specific

Open
#562 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
563
Forks
108
Avg merge
4d 13h
Merged PRs (30d)
3

Description

As discussed in solid/notifications#187

RFC9205 recommends:

Specifications should use [HTTP] as the primary reference for HTTP; it is not necessary to reference all of the specifications in the HTTP suite unless there are specific reasons to do so (e.g., a particular feature is called out).

In light of this, consider removing references to RFC9112 (in lieu of RFC7321) and RFC9113 (in lieu of RFC7540), unless specific reference is made respectively to an HTTP/1.1 or HTTP/2 specific feature. Examples include definitions for Server and Client amongst others.

Yet in other sections, such as security considerations, one might want to add references to RFC9114 (HTTP/3).

Contributor guide

Open the contributing guide

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 searching the specification text for references to RFC9112 and RFC9113, then compare each use with RFC9205's guidance. Keep references where HTTP/1.1 or HTTP/2-specific features are discussed, and consider RFC9114 for relevant HTTP/3 security considerations; done means the references are specific and consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.