Skip to content

Link the relevant specs/docs from the README #501

Open
@oliverklee

Description

@oliverklee

User stories

As a developer of this library, I want the relevant specs I need to know for developing this library linked from the README for easy access.

As a user of this library, , I want the relevant specs linked from the README for easy access so I can look up the terms this library uses and the expected data structures.

Acceptance criteria

  • There is a section on specs and RFCs in the README.
  • The relevant specs are listed with a short explanation what they define and what use they are for developers and users of this library.
  • When there are multiple sources for some RFC, favor the authoritative source over the secondary source, and favor easy-to-read sources (which might be conflicting requirements).
  • The README is auto-formatted according to the .editorconfig.

Helpful links

This is a starting point. Not all of these URLs need necessarily end up in the README, and there might be other URLs that are not listed here and that are helpful to add to the README as well.

Additional information

This task requires understanding which RFCs are relevant to this project, and looking through the suggested sources and looking for additional sources.

Metadata

Metadata

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions