From 451399082a0bf99580ae72423f9c49f73b090c5d Mon Sep 17 00:00:00 2001
From: Tom Henderson <tomh@tomh.org>
Date: Thu, 2 Mar 2023 19:45:38 -0800
Subject: [PATCH] doc: Update and align all document indices

---
 doc/contributing/source/index.rst | 22 +++++++++++++++-------
 doc/installation/source/index.rst | 15 +++++++--------
 doc/manual/source/index.rst       | 21 +++++++++++++++------
 doc/models/source/index.rst       | 22 ++++++++++++++++------
 doc/tutorial/source/index.rst     | 23 ++++++++++++++++-------
 5 files changed, 69 insertions(+), 34 deletions(-)

diff --git a/doc/contributing/source/index.rst b/doc/contributing/source/index.rst
index 93e64f285..7604e4194 100644
--- a/doc/contributing/source/index.rst
+++ b/doc/contributing/source/index.rst
@@ -3,16 +3,24 @@
 Contributing to ns-3
 ====================
 
-This is the guide to *Contributing to ns-3*. Primary documentation for the ns-3 project is available in several forms:
+This is the *ns-3 Contributing Guide*. Primary documentation for the ns-3 project is organized as
+follows:
 
-* `ns-3 Doxygen <http://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of the simulator
-* Tutorial for the `latest release <http://www.nsnam.org/documentation/latest/>`_ and `development tree <https://www.nsnam.org/documentation/>`_
-* Contributing to ns-3 (this document)
-* Manual, and Model Library for the `latest release <http://www.nsnam.org/documentation/latest/>`_ and `development tree <https://www.nsnam.org/documentation/>`_
-* `ns-3 wiki <http://www.nsnam.org/wiki/Main_Page>`_
+* Several guides that are version controlled for each release (the
+  `latest release <https://www.nsnam.org/documentation/latest/>`_) and
+  `development tree <https://www.nsnam.org/ns-3-dev/documentation/>`_:
+
+  * Tutorial
+  * Installation Guide
+  * Manual
+  * Model Library
+  * Contributing Guide *(this document)*
+* `ns-3 Doxygen <https://www.nsnam.org/docs/doxygen/index.html>`_: Documentation of the public APIs of
+  the simulator
+* `ns-3 wiki <https://www.nsnam.org/wiki/Main_Page>`_
 
 This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <https://www.sphinx-doc.org/>`_ and is maintained in the
-``doc/contributing`` directory of ns-3's source code.
+``doc/contributing`` directory of ns-3's source code.  Source file column width is 100 columns.
 
 .. toctree::
    :maxdepth: 2
diff --git a/doc/installation/source/index.rst b/doc/installation/source/index.rst
index 25bf96928..cbc5d8623 100644
--- a/doc/installation/source/index.rst
+++ b/doc/installation/source/index.rst
@@ -7,21 +7,20 @@ This is the *ns-3 Installation Guide*. Primary documentation for the ns-3 projec
 follows:
 
 * Several guides that are version controlled for each release (the
-  `latest release <http://www.nsnam.org/documentation/latest/>`_) and
-  `development tree <http://www.nsnam.org/ns-3-dev/documentation/>`_:
+  `latest release <https://www.nsnam.org/documentation/latest/>`_) and
+  `development tree <https://www.nsnam.org/ns-3-dev/documentation/>`_:
 
-  * Installation Guide (this document)
   * Tutorial
+  * Installation Guide *(this document)*
   * Manual
   * Model Library
-  * Contributing
-* `ns-3 Doxygen <http://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of
+  * Contributing Guide
+* `ns-3 Doxygen <https://www.nsnam.org/docs/doxygen/index.html>`_: Documentation of the public APIs of
   the simulator
-* `ns-3 wiki <http://www.nsnam.org/wiki/Main_Page>`_
+* `ns-3 wiki <https://www.nsnam.org/wiki/Main_Page>`_
 
 This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_
-for `Sphinx <http://sphinx.pocoo.org/>`_ and is maintained in Tom Henderson's 'installation-guide' branch
-until it is ready to publish.  Source file column width is 100 columns.
+for `Sphinx <http://sphinx.pocoo.org/>`_ and is maintained in the ``doc/installation`` directory of ns-3's source code.  Source file column width is 100 columns.
 
 .. toctree::
    :maxdepth: 2
diff --git a/doc/manual/source/index.rst b/doc/manual/source/index.rst
index 35c486d50..534153633 100644
--- a/doc/manual/source/index.rst
+++ b/doc/manual/source/index.rst
@@ -3,15 +3,24 @@
 ns-3 Manual
 ===========
 
-This is the *ns-3 Manual*. Primary documentation for the ns-3 project is
-available in five forms:
+This is the *ns-3 Manual*. Primary documentation for the ns-3 project is organized as
+follows:
 
-* `ns-3 Doxygen <https://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of the simulator
-* Tutorial, Manual *(this document)*, and Model Library for the `latest release <https://www.nsnam.org/documentation/latest/>`_ and `development tree <https://www.nsnam.org/documentation/development-tree/>`_
-* `ns-3 wiki <https://www.nsnam.org/wiki>`_
+* Several guides that are version controlled for each release (the
+  `latest release <https://www.nsnam.org/documentation/latest/>`_) and
+  `development tree <https://www.nsnam.org/ns-3-dev/documentation/>`_:
+
+  * Tutorial
+  * Installation Guide
+  * Manual *(this document)*
+  * Model Library
+  * Contributing Guide
+* `ns-3 Doxygen <https://www.nsnam.org/docs/doxygen/index.html>`_: Documentation of the public APIs of
+  the simulator
+* `ns-3 wiki <https://www.nsnam.org/wiki/Main_Page>`_
 
 This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <https://www.sphinx-doc.org/>`_ and is maintained in the
-``doc/manual`` directory of ns-3's source code.
+``doc/manual`` directory of ns-3's source code.  Source file column width is 100 columns.
 
 .. toctree::
    :maxdepth: 2
diff --git a/doc/models/source/index.rst b/doc/models/source/index.rst
index a6b6ee6a6..29b6d3bba 100644
--- a/doc/models/source/index.rst
+++ b/doc/models/source/index.rst
@@ -3,15 +3,25 @@
 ns-3 Model Library
 ==================
 
-This is the *ns-3 Model Library* documentation. Primary documentation for the ns-3 project is
-available in five forms:
+This is the *ns-3 Model Library* documentation. Primary documentation for the ns-3 project is organized as
+follows:
 
-* `ns-3 Doxygen <https://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of the simulator
-* Tutorial, Manual, and Model Library *(this document)* for the `latest release <https://www.nsnam.org/documentation/latest/>`_ and `development tree <https://www.nsnam.org/documentation/development-tree/>`_
-* `ns-3 wiki <https://www.nsnam.org/wiki>`_
+* Several guides that are version controlled for each release (the
+  `latest release <https://www.nsnam.org/documentation/latest/>`_) and
+  `development tree <https://www.nsnam.org/ns-3-dev/documentation/>`_:
+
+  * Tutorial
+  * Installation Guide
+  * Manual
+  * Model Library *(this document)*
+  * Contributing Guide
+* `ns-3 Doxygen <https://www.nsnam.org/docs/doxygen/index.html>`_: Documentation of the public APIs of
+  the simulator
+* `ns-3 wiki <https://www.nsnam.org/wiki/Main_Page>`_
 
 This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <https://www.sphinx-doc.org/>`_ and is maintained in the
-``doc/models`` directory of ns-3's source code.
+``doc/models`` directory of ns-3's source code (and much of the source content is also pulled
+from the ``doc/`` directory of each module.  Source file column width is 100 columns.
 
 .. toctree::
    :maxdepth: 1
diff --git a/doc/tutorial/source/index.rst b/doc/tutorial/source/index.rst
index 1e7cc072e..042b1efd0 100644
--- a/doc/tutorial/source/index.rst
+++ b/doc/tutorial/source/index.rst
@@ -1,17 +1,26 @@
 .. only:: html or latex
 
 ns-3 Tutorial
-===========================
+=============
 
-This is the *ns-3 Tutorial*. Primary documentation for the ns-3 project is
-available in five forms:
+This is the *ns-3 Tutorial*. Primary documentation for the ns-3 project is organized as
+follows:
 
-* `ns-3 Doxygen <https://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of the simulator
-* Tutorial *(this document)*, Manual, and Model Library for the `latest release <https://www.nsnam.org/documentation/latest/>`_ and `development tree <https://www.nsnam.org/documentation/development-tree/>`_
-* `ns-3 wiki <https://www.nsnam.org/wiki>`_
+* Several guides that are version controlled for each release (the
+  `latest release <https://www.nsnam.org/documentation/latest/>`_) and
+  `development tree <https://www.nsnam.org/ns-3-dev/documentation/>`_:
+
+  * Tutorial *(this document)*
+  * Installation Guide
+  * Manual
+  * Model Library
+  * Contributing Guide
+* `ns-3 Doxygen <https://www.nsnam.org/docs/doxygen/index.html>`_: Documentation of the public APIs of
+  the simulator
+* `ns-3 wiki <https://www.nsnam.org/wiki/Main_Page>`_
 
 This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <https://www.sphinx-doc.org/>`_ and is maintained in the
-``doc/tutorial`` directory of ns-3's source code.
+``doc/tutorial`` directory of ns-3's source code.  Source file column width is 100 columns.
 
 .. toctree::
    :maxdepth: 2