pointless.one/rfcs-docset
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
8 commits 1 branch 0 tags 388 KiB
Find a file
Exact
Alexander Mankuta 0ff3cc0df2 Remove stale documents from the docset before writing new ones
2024-10-01 18:35:36 +03:00
data v 1.0.0 2024-09-21 18:17:38 +03:00
.gitignore v 1.0.0 2024-09-21 18:17:38 +03:00
LICENSE v 1.0.0 2024-09-21 18:17:38 +03:00
Rakefile Remove stale documents from the docset before writing new ones 2024-10-01 18:35:36 +03:00
README.md v 1.0.0 2024-09-21 18:17:38 +03:00
screenshot.png v 1.0.0 2024-09-21 18:17:38 +03:00

README.md

Dash RFCs.docset

This is a docset for Dash.app containing all published RFCs from the IETF.

Dash screenshot showing RFC 9654

Installing

Install by opening Dash.app preferences, switch to Downloads, open User Contributed, and search for "RFCs".

The unpacked docset will take a about 730 MB on disk. Enabling full-text search might need additional 200 MB.

Updating the Docset

Updating the docset requires Ruby. Any currently supported Ruby should work (3.1 to 3.4 as of time of writing). The script has a few dependencies that should be installed automatically.

Update consists of two phases: downloading the latest RFCs and generating the docset.

To download the latest RFCs, run the rake sync.

To generate the docset, run the rake dist.

Running rake command will run both tasks in sequence.

License

The RFCs themselves contained in this repo are subject to the IETF IPR policy. The scripts used to construct the docset are released under an Apache 2.0 license.