rfc/README.md
Oskar Thorén 27ee0f0558
Merge repo with rfc.vac.dev (#310)
* Hugo init

* Init Hugo book

* Add basic README and title

* Import RFC: 1/COSS

* Move example content to dedicated folder

* Basic menu

* Tweak single layout

* Fix base url and permalink

* Basic index tweaks

* Add netifly config

* gitignore

* 1/COSS: Add COSS lifecycle

* Remove public artifact

* Add basic numbers in menu

* Empty READMEs init

* Import mvds spec raw

* 2/MVDS: Simplify

* 3/REMOTE-LOG: Import

* 3/REMOTE-LOG: Simplify

* 4/MVDS-META: Import

* 4/MVDS-META Simplify

* Tweaks

* 5/WAKU0: Import

* 5: Simplify

* 6/WAKU1: Import

* 6/WAKU1: Simplify

* 7/WAKU-DATA: Import

* 7/WAKU-DATA: Simplify

* 8/WAKU-MAIL: Import

* 8/WAKU-MAIL: Simplify

* Tweak

* 9/WAKU-RPC: Import

* 9/WAKU-RPC: Simplify

* 10/WAKU2: Import

* 10/WAKU2: Simplify

* 11/WAKU-RELAY: Import

* Tweaks

* 11/WAKU-RELAY: Simplify

* 12/WAKU-FILTER: Import

* 12/WAKU2-FILTER: Simplify

* 13/WAKU-STORE: Import

* 13/WAKU-STORE: Simplify

* 14/WAKU-MESSAGE: Import

* 14/WAKU-MESSAGE: Simplify

* 15/WAKU-BRIDGE: Import

* 15: Simplify

* 16: Import

* 16: Simplify

* 17: Import

* 17: Simplify

* 18: Import

* 18: Simplify

* 12: Bump update

* 14: Bump update

* 11: Bump update

* 17: Bump update

* 18: Bump update

* 16: Bump update

* Fix slug for 18

* Editor changes for 11, 12, 15

* Revert "Editor changes for 11, 12, 15"

This reverts commit 5c32fe791bec57ca1d5326e0d2724339f12a784a.

* Revert "Revert "Editor changes for 11, 12, 15""

This reverts commit ccd75131d72a1f1c43b701f445fe66ebd6857fc4.

* Editor changes for 13, 2, 4

* Move current specs to archive

* Update README

* bump
2021-04-01 12:03:14 +08:00

1.8 KiB

rfc.vac.dev

This repository contains the specs for vac, a modular peer-to-peer messaging stack, with a focus on secure messaging. A detailed explanation of the vac and its design goals can be found here.

See rfc.vac.dev.

Contributing

Please see 1/COSS for general guidelines and spec lifecycle.

Building locally

Ensure you have the Hugo extended edition (https://gohugo.io/getting-started/installing/), then run hugo server.

These protocols define various components of the vac stack.

Style guide

Sequence diagrams are generated using Mscgen like this: mscgen -T png -i input.msc -o output.png. Both the source and generated image should be in source control. For ease of readability, the generated image is embedded inside the main spec document.

Alternatively, mscgenjs can be used to generate sequence diagrams (mscgenjs produces better quality figures especially concerning lines' spaces and figures' margins). Once installed, the following command can be used to generate the sequence diagrams mscgenjs -T png -i input.msc -o output.png. More details on the installation and compilation are given in mscgenjs repository. You may try the online playground https://mscgen.js.org/ as well to get a sense of the output figures.

Meta

The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

Acknowledgement

Site layout and process inspired by https://rfc.zeromq.org/