summaryrefslogtreecommitdiffstats
path: root/doc/readthedocs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/readthedocs/index.rst')
-rw-r--r--doc/readthedocs/index.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/readthedocs/index.rst b/doc/readthedocs/index.rst
new file mode 100644
index 0000000..ad927fe
--- /dev/null
+++ b/doc/readthedocs/index.rst
@@ -0,0 +1,30 @@
+Welcome to nvme-stas's documentation!
+=====================================
+
+What does nvme-stas provide?
+
+* A Central Discovery Controller (CDC) client for Linux
+* Asynchronous Event Notifications (AEN) handling
+* Automated NVMe subsystem connection controls
+* Error handling and reporting
+* Automatic (zeroconf) and Manual configuration
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ installation.rst
+ nvme-stas.rst
+ stafd-index.rst
+ stacd-index.rst
+ stasadm.rst
+ sys.conf.rst
+ stas-config.target.rst
+ stas-config@.service.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`