Doug Hellmann 9599ffe65d reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification.

Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.

Add a few toctrees and index pages for the new directories.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-23 11:54:32 +02:00

45 lines
1.2 KiB
ReStructuredText

=============
Command Specs
=============
Specifications for new commands, objects and actions are listed below.
These specifications have not been implemented. See
:ref:`command-list` for implemented commands and
:ref:`command-structure` for implemented objects and actions.
It is optional to propose a specifications patch for new commands,
objects and actions here before submitting the implementation. Once your
specifications patch merges then you may proceed with the implementation.
Your implementation patches should move applicable portions of the
specifications patch to the official :ref:`command-list`
and :ref:`command-structure` documentation.
Objects Specs
-------------
Add specifications for new objects based on the ``example`` object.
Actions Specs
-------------
Add specifications for new actions based on the ``example`` action.
.. toctree::
:maxdepth: 1
network-topology
Commands Specs
--------------
Add specifications for new commands based on the commands for the
``example`` object. The ``example`` commands are not intended to
be a complete template for new commands since other actions, options
and/or arguments may be used.
.. toctree::
:glob:
:maxdepth: 2
command-objects/*