solid / solid/specification

Language and aref hooks for other specs

Open
#260 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

category: editorial doc: Protocol
Dominant language
HTML
Stars
563
Forks
108
Avg merge
4d 13h
Merged PRs (30d)
3

Description

After thinking a bit about general editorial issues in the protocol, I think the issue that got most prominent in my mind was that we need more hooks for other specs to reference when they need to. Let me take a concrete example:

In the interop spec, they say e.g.:

  1. MUST return 404 if TREE or REGISTRY cannot be successfully dereferenced.

This is actually and additional restriction on the implementations of Solid servers (as the protocol specifies that amongst other things, a 410 may be returned if the resource has previously existed), which shouldn't be done, and shouldn't be necessary to do.

Instead, specs like the interop specs should have terms to point to, something like "return a non-existent resource error if TREE or REGISTRY cannot be successfully dereferenced.", and then, "non-existent resource error" is a term that we should use in the protocol spec to refer to that kind of situation, and then say that it would mean 404 or 410 or whatever. Those terms should also have ids, so that they can link right to them.

This, I hope, will enable other specs to not define anything that has to do with the protocol, and so enable orthogonality.

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 reviewing the protocol specification's existing error terminology and the interop specification's TREE and REGISTRY dereferencing requirement. Define the cross-specification terms, linkable ids, and status-code semantics needed so related specifications can reference the protocol without redefining it.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.