solid / solid/specification

Implementation reports

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

Nobody has claimed this yet.

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

Description

Where applicable, specifications should link to a document about the implementation reports - a summary/index. In addition to making implementations discoverable via specification, it communicates what could be used with their coverage. It provides supporting data/evidence for success/exit criteria ( https://github.com/solid/specification/issues/373 ) as well as the conformance criteria ( https://github.com/solid/specification/issues/282 ).

The summary/index (in RDF) can be similar to https://www.w3.org/TR/ldn/ linking to https://linkedresearch.org/ldn/tests/summary where individual implementation report (in RDF) can also be found. Where the projects implementing the specifications are also described in RDF... we end up with this (overview): https://csarven.ca/media/images/articles/linked-specifications-reports.svg .

This will generally require the summary/index document to be either updated manually or generated automatically, e.g., based on reports submitted (typically by the maintainer of the project implementing the specification) to a repository or to an inbox - the latter is the approach taken with LDN /ldn/tests/reports/ - and conforming reports are included in the summary.

For the summary and individual implementation reports, we'll need to allocate a URI space (similar to publishing technical reports /TR/{id})

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 linked issues 373 and 282, then compare the LDN summary and individual report examples referenced in the issue. Done would require a decided approach for specification links, RDF summary and implementation reports, report URI space, and whether the index is updated manually or generated from submissions.

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
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.