nlohmann / rfc-docset Goto Github PK

The docset generation guide describes how a table of contents can be displayed automatically in Dash. This requires additional markup in the HTML documents.

The docset generation guide describes how a zipped archive can be offered as feed. This also allows to integrate the docset with a single click with a dash-feed:// URL scheme.

The TOC entries seem to be ordered by alphabet rather than by the document order. Consequently, numbers are in the order 1, 10, 11, ..., 2, 20, 21, ..., 3... etc.

The docset generation guide describes how each document can contain a link to its online version. This is more elegant than to use a global DashDocSetFallbackURL.

BCP documents should also be added. An index can be found here:

• https://www.rfc-editor.org/search/rfc_search_detail.php?page=All&rfc=bcp
• https://www.ietf.org/rfc/bcp-index.txt

Adding BCPs should also fix this part of #2.

A lot of RFCs have a section like

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].

It could be convenient to add special markup to these words when used in an RFC.

Any link with a target other than an RFC is broken. Examples:

• The [Docs] link on any RFC top.
• The [txt|pdf] links on any RFC top.
• Links to drafts.
• Links to diffs.
• Links to errata documents.
• Links to BCP documents.

The docset creation guide suggests to add an icon to a docset.