vacp2p
/
rfc
mirror of https://github.com/vacp2p/rfc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Modular p2p messaging stack, with a focus on secure messaging. https://rfc.vac.dev/
426 Commits 45 Branches 11 Tags 32 MiB
HTML 77.9%
Dockerfile 22.1%
Go to file
fryorcraken.eth 9645e72011
Fix title (#559) 
Co-authored-by: fryorcraken.eth <franck@status.im>
 		2022-12-02 14:27:03 +08:00
.github chore: Add GH labels (#516) 2022-07-27 18:33:16 +08:00
archetypes Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
ci ci: add Jenkinsfile for site CI builds (#558) 2022-12-02 12:51:27 +08:00
content Fix title (#559) 2022-12-02 14:27:03 +08:00
example-content Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
layouts/docs Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
resources/_gen/assets/scss Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
static ci: add Jenkinsfile for site CI builds (#558) 2022-12-02 12:51:27 +08:00
themes Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
.gitignore Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
.gitmodules Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
.pyspelling.yml Update main.yml (#136) 2020-05-28 11:46:43 +02:00
.remarkrc adds link checks (#131) 2020-05-21 12:20:44 +08:00
.textlintrc text-lint (#134) 2020-05-25 11:55:06 +02:00
README.md ci: add Jenkinsfile for site CI builds (#558) 2022-12-02 12:51:27 +08:00
config.toml http -> https (#328) 2021-04-06 16:50:48 +08:00

README.md

Vac RFCs

This repository contains specifications for the Vac project. Vac is an R&D org creating modular p2p protocols for private, secure, and censorship-resistant communication. A detailed, albeit slightly outdated (2019), explanation of Vac and its design goals can be found here.

Vac RFCs (Request for Comments) includes specs for the Waku family of specs, but also other things such as: node discovery, data sync, recommendations around usage, spec process, interfacing with auxiliary systems such as distributed storage, payload encryption, and so on.

Vac, while having a core team of maintainers and contributors, is an open and permission-less organization.

See rfc.vac.dev for an easy to browse index of all RFCs.

Contributing

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

Feel free to join the Vac discord. There's a channel specifically for RFC discussions.

Here's the project board used by core contributors and maintainers: https://github.com/orgs/vacp2p/projects/5

Building locally

Run git submodule update --init to install the Hugo "book" theme. 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.

Continuous Integration

The master branch is built by our Jenkins instance and deployed to https://rfc.vac.dev/.

Acknowledgement

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