diff --git a/source/specifications/index.rst b/source/specifications/index.rst index 21b09bd..c0ec164 100644 --- a/source/specifications/index.rst +++ b/source/specifications/index.rst @@ -1,11 +1,91 @@ Specifications ============== -You'll find all specifications for future features -here. The documentation is removed from this -document when the feature is implemented, and -rewritten into developing, administration and user -manuals. + +NEPs +^^^^ + +Nerv Tales Network Enhancement Proposals are the +official continuous specification of project and +of management process. See doc:`neps/00001` +for more information. + +.. note:: + + Title of NEP contains its status: + + - [C] Continuously updated + - [E] Experimental + - [P] Proposed + - [S] Stable + - [D] Deprecated + - [O] Obsolete + - [R] Rejected or retracted + + Only procedural and informational NEP can be + continuously updated. + +Active +~~~~~~ + +Procedural +---------- + +.. toctree:: + :maxdepth: 1 + + neps/00001 + neps/00002 + +Informational +------------- + +Protocol +-------- + +.. toctree:: + :maxdepth: 1 + + neps/00003 + neps/00004 + +Features +-------- + +.. toctree:: + :maxdepth: 1 + + neps/00005 + neps/00006 + neps/00007 + neps/00008 + +Other +----- + +Archive +~~~~~~~ + +Procedural +---------- + +Informational +------------- + +Protocol +-------- + +Features +-------- + +Other +----- + +Features to develop +^^^^^^^^^^^^^^^^^^^ + +Some big features need to be developed, but we don't +write the NEP at this moment. .. toctree:: diff --git a/source/specifications/neps/00001.rst b/source/specifications/neps/00001.rst new file mode 100644 index 0000000..fe79bd4 --- /dev/null +++ b/source/specifications/neps/00001.rst @@ -0,0 +1,42 @@ +[C] NEP00001 - NEP and development process +========================================== + +Objectives +^^^^^^^^^^ + +Nerv Tales Network Enhancement Proposals or NEPs define +the development process, protocol, features and all +information needed for the project. + +Base requirements +^^^^^^^^^^^^^^^^^ + +NEP Types +^^^^^^^^^ + +Submission +^^^^^^^^^^ + +Approval +^^^^^^^^ + +NEP states +^^^^^^^^^^ + +Documentation +^^^^^^^^^^^^^ + +Testing +^^^^^^^ + +Code contribution +^^^^^^^^^^^^^^^^^ + +External libraries +^^^^^^^^^^^^^^^^^^ + +Risk management +^^^^^^^^^^^^^^^ + +Issues +^^^^^^ diff --git a/source/specifications/neps/00002.rst b/source/specifications/neps/00002.rst new file mode 100644 index 0000000..f85e89d --- /dev/null +++ b/source/specifications/neps/00002.rst @@ -0,0 +1,20 @@ +[C] NEP00002 - Code convention +============================== + +ReStructuredText +^^^^^^^^^^^^^^^^ + +Python +^^^^^^ + +JavaScript +^^^^^^^^^^ + +Vue.js +^^^^^^ + +HTML +^^^^ + +CSS +^^^ diff --git a/source/specifications/neps/00003.rst b/source/specifications/neps/00003.rst new file mode 100644 index 0000000..ef8ec9f --- /dev/null +++ b/source/specifications/neps/00003.rst @@ -0,0 +1,9 @@ +[E] NEP00003 - Base protocol +============================ + +Objectives +^^^^^^^^^^ + +XMPP use +^^^^^^^^ + diff --git a/source/specifications/neps/00004.rst b/source/specifications/neps/00004.rst new file mode 100644 index 0000000..252adf7 --- /dev/null +++ b/source/specifications/neps/00004.rst @@ -0,0 +1,14 @@ +[E] NEP00004 - Security protocol +================================ + +Objectives +^^^^^^^^^^ + +Architecture +^^^^^^^^^^^^ + +Encryption +^^^^^^^^^^ + +Key management +^^^^^^^^^^^^^^ diff --git a/source/specifications/neps/00005.rst b/source/specifications/neps/00005.rst new file mode 100644 index 0000000..4681c6f --- /dev/null +++ b/source/specifications/neps/00005.rst @@ -0,0 +1,16 @@ +[E] NEP00005 - Authentication and encryption +============================================ + +Objectives +^^^^^^^^^^ + +Authentication process +^^^^^^^^^^^^^^^^^^^^^^ + +Encryption level +^^^^^^^^^^^^^^^^ + +Database encryption +^^^^^^^^^^^^^^^^^^^ + + diff --git a/source/specifications/neps/00006.rst b/source/specifications/neps/00006.rst new file mode 100644 index 0000000..412772a --- /dev/null +++ b/source/specifications/neps/00006.rst @@ -0,0 +1,33 @@ +[E] NEP00006 - Contact management +================================= + +Objectives +^^^^^^^^^^ + +Contact list +^^^^^^^^^^^^ + +Informations +^^^^^^^^^^^^ + +Avatar +^^^^^^ + +Update process +^^^^^^^^^^^^^^ + +Using internal or provided informations +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Contact Sharing +^^^^^^^^^^^^^^^ + +vCard export +^^^^^^^^^^^^ + +DAV connector +^^^^^^^^^^^^^ + +JMAP connector +^^^^^^^^^^^^^^ + diff --git a/source/specifications/neps/00007.rst b/source/specifications/neps/00007.rst new file mode 100644 index 0000000..80f8e43 --- /dev/null +++ b/source/specifications/neps/00007.rst @@ -0,0 +1,102 @@ +[E] NEP00007 - Messaging (chat and mail) +======================================== + +Objectives +^^^^^^^^^^ + +Instant and non-instant +^^^^^^^^^^^^^^^^^^^^^^^ + +Private and group chat +^^^^^^^^^^^^^^^^^^^^^^ + +Notification +^^^^^^^^^^^^ + +Formatting +^^^^^^^^^^ + +Contact management +^^^^^^^^^^^^^^^^^^ + +Threading +^^^^^^^^^ + +Forwarding +^^^^^^^^^^ + +Servers, categories and rooms +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Mailing-list +^^^^^^^^^^^^ + +Tags and folders +^^^^^^^^^^^^^^^^ + +File attachment +^^^^^^^^^^^^^^^ + +Images and animations +^^^^^^^^^^^^^^^^^^^^^ + +Emoticons and stickers +^^^^^^^^^^^^^^^^^^^^^^ + +Links +^^^^^ + +Audio and video messages +^^^^^^^^^^^^^^^^^^^^^^^^ + +Streams and calls +^^^^^^^^^^^^^^^^^ + +Message sharing +^^^^^^^^^^^^^^^ + +Mailbox sharing +^^^^^^^^^^^^^^^ + +Communication with anonymous +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Website chat and contact form +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Blog, document, file or other object's comments +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Security and HTML threats +^^^^^^^^^^^^^^^^^^^^^^^^^ + +SPAM management +^^^^^^^^^^^^^^^ + +Log and headers +^^^^^^^^^^^^^^^ + +Accessibility features +^^^^^^^^^^^^^^^^^^^^^^ + +(like subtitling and/or signing by other people) + +IMAP connector +^^^^^^^^^^^^^^ + +JMAP connector +^^^^^^^^^^^^^^ + +SMTP connector +^^^^^^^^^^^^^^ + +DKIM, SPF and DMARC +^^^^^^^^^^^^^^^^^^^ + +SIP connector +^^^^^^^^^^^^^ + +Social network connectors +^^^^^^^^^^^^^^^^^^^^^^^^^ + +(Connect to Matrix, Mastodon, Diaspora, Facebook, Twitter). diff --git a/source/specifications/neps/00008.rst b/source/specifications/neps/00008.rst new file mode 100644 index 0000000..ecd7568 --- /dev/null +++ b/source/specifications/neps/00008.rst @@ -0,0 +1,5 @@ +[E] NEP00008 - File management +============================== + +Objectives +^^^^^^^^^^