Browse Source

Add specification

master
juga 5 months ago
parent
commit
85923f28bf
4 changed files with 77 additions and 3 deletions
  1. +1
    -1
      .gitlab-ci.yml
  2. +6
    -0
      source/conf.py
  3. +15
    -2
      source/index.rst
  4. +55
    -0
      source/specification.md

+ 1
- 1
.gitlab-ci.yml View File

@ -3,7 +3,7 @@ image: python:3.7-buster
pages:
stage: deploy
script:
- pip install -U sphinx
- pip install -U sphinx recommonmark
- make html
- mv build/html public
artifacts:


+ 6
- 0
source/conf.py View File

@ -176,3 +176,9 @@ epub_title = project
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}
source_suffix = ['.rst', '.md']

+ 15
- 2
source/index.rst View File

@ -27,8 +27,21 @@ Design
Design/*
.. toctree::
:maxdepth: 2
:glob:
:maxdepth: 1
Specification
-------------
.. toctree::
:maxdepth: 1
specification
Roadmap
-------
.. toctree::
:maxdepth: 1
roadmap


+ 55
- 0
source/specification.md View File

@ -0,0 +1,55 @@
The following is in markdown so that kramdown can convert it to xml for RFCs.
Introduction
============
TBD
Requirements Language
---------------------
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
"SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in BCP 14 ([RFC2119] and [RFC8174])
when, and only when, they appear in all capitals, as shown here.
Terminology
-----------
TBD
Own vs existing.
Mix network/mixnet
Onion routing
Remailer
Node
Mix
client
pEp engine
GNUnet node
GNS Resolution
GNS Registration
GNS Delegation
Message
All the content
===============
TBD
Security Considerations
=======================
TBD

Loading…
Cancel
Save