diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e8192b4..b86a9cb 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -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: diff --git a/source/conf.py b/source/conf.py index 09a7d70..1ed5278 100644 --- a/source/conf.py +++ b/source/conf.py @@ -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'] diff --git a/source/index.rst b/source/index.rst index 798a2de..6b2140b 100644 --- a/source/index.rst +++ b/source/index.rst @@ -27,8 +27,21 @@ Design Design/* .. toctree:: - :maxdepth: 2 - :glob: + :maxdepth: 1 + +Specification +------------- + +.. toctree:: + :maxdepth: 1 + + specification + +Roadmap +------- + +.. toctree:: + :maxdepth: 1 roadmap diff --git a/source/specification.md b/source/specification.md new file mode 100644 index 0000000..44b137e --- /dev/null +++ b/source/specification.md @@ -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