From 095239eace352ab194c23be1423b61da8351d33f Mon Sep 17 00:00:00 2001
From: currite <sll@disroot.org>
Date: Fri, 6 Nov 2020 16:51:13 +0100
Subject: index: establish highlighted blocks without affecting links

Add toctree captions and names to separate blocks
(similar to 1.3 index) without affecting existing links
---
 docs/index.rst | 51 ++++++++++++++++-----------------------------------
 1 file changed, 16 insertions(+), 35 deletions(-)

(limited to 'docs/index.rst')

diff --git a/docs/index.rst b/docs/index.rst
index e6e2bf38..d0f2c6e7 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,40 +1,26 @@
 .. _index:
 
+###############
 VyOS User Guide
-===============
+###############
 
-VyOS is an open source network operating system based on Debian GNU/Linux.
 
-VyOS provides a free routing platform that competes directly with other
-commercially available solutions from well known network providers. Because
-VyOS is run on standard amd64, i586 and ARM systems, it is able to be used
-as a router and firewall platform for cloud deployments.
-
-#####
-About
-#####
-
-We use multiple live versions of our manual hosted thankfully by
-https://readthedocs.org. We will provide one version of the manual for every
-VyOS major version starting with VyOS 1.2 which will receive Long-term support
-(LTS).
-
-The manual version is selected/specified by it's Git branch name. You can
-switch between versions of the documentation by selecting the appropriate
-branch on the bottom left corner.
-
-############
-Introduction
-############
-
-.. _introduction:
 .. toctree::
+   :caption: Introduction
+   :name: intro
    :maxdepth: 2
 
+   about
    history
    install
    cli
    quick-start
+
+.. toctree::
+   :caption: Configuration
+   :name: configuration
+   :maxdepth: 2
+
    configuration-overview
    interfaces/index
    routing/index
@@ -51,12 +37,10 @@ Introduction
 .. modules
 
 
-########
-Appendix
-########
 
-.. _appendix:
 .. toctree::
+   :caption: Appendix
+   :name: appendix
    :maxdepth: 2
 
    appendix/releasenotes
@@ -69,14 +53,11 @@ Appendix
    appendix/migrate-from-vyatta
 
 
-############
-Contributing
-############
-
-.. _contributing:
 .. toctree::
+   :caption: Contributing
+   :name: contributing
    :maxdepth: 2
-
+   
    contributing/issues_features
    contributing/development
    contributing/documentation
-- 
cgit v1.2.3