solid / solid/specification

Document and inform about the level of adoption of Technical Reports

Open
#402 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Document and inform about the level of adoption of Technical Reports (TR) for different audiences.

Useful to implementers, developers, contributors to TRs (including Work Items), and general public.

Level of Adoption:

  • Refine metrics: implementation, intent to implement, community adoption (, standard track).
  • Display the metrics in TRs.
  • Create general report on the level of adoption of TRs.
  • Establish Group guidance on how to increase implementation experience.

Considerations:

  • Different classes of TRs and so implementation types (where some may not have test reports).
  • Conformance to a TR as a whole backed by data from test reports (and elsewhere).
  • Specific feature support backed by data from test reports (and elsewhere).
  • May need to convey a lot of information in a limited space.
  • TRs are static documents. Compatibility data is dynamic and external to TRs.

Related:


Bonus (eating our own cooking): Build other Solid applications using data from TRs, test reports, and implementations.

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

The issue names no files or tests; begin by reviewing related issues #383 and #281 and the existing Technical Reports. Done means an agreed way to define and present adoption metrics, plus the requested general report and guidance, with any implementation-facing follow-up made explicit.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
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.