doc: refactor, let first page be table of contents

- Drop doc/README.md symlink to variant.md
 - Make doc/README.md the table of contents
 - Clean up variant.md, OSPF and containers now fully supported

Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
This commit is contained in:
Joachim Wiberg
2024-03-22 05:34:36 +01:00
parent b2fef1585f
commit 2eb487ebcd
6 changed files with 60 additions and 132 deletions
-1
View File
@@ -1 +0,0 @@
variant.md
+33
View File
@@ -0,0 +1,33 @@
Welcome to Infix, your friendly Network Operating System! On these
pages you can find both user and developer documentation.
> Topics on configuring the system include CLI examples, every setting
> is also possible to perform using NETCONF. In fact, the Infix test
> system solely relies on NETCONF for configuring network topologies.
The CLI documentation is also available from inside the CLI itself using
the `help` command.
- **CLI Topics**
- [Introduction to the CLI](cli/introduction.md)
- [CLI User's Guide](cli/tutorial.md)
- [Quick Overview](cli/quick.md)
- **Infix User Guide**
- [Network Configuration](networking.md)
- **Infix In-Depth**
- [Boot Procedure](boot.md)
- [Branding & Releases](branding.md)
- [Containers in Infix](container.md)
- [Find Your Device on the Network](discovery.md)
- [Hardware Info & Status](hardware.md)
- [Infix Variants](variant.md)
- [Virtual Environments](virtual.md)
- [Vital Product Data (VPD)](vpd.md)
- [YANG to Ethtool Mapping](eth-counters.md)
- [Origin & Licensing](license.md)
- **Developer Topics**
- [Developer's Guide](developers-guide.md)
- [Developing with Infix](override-package.md)
- [Regression Testing with Infamy](testing.md)