From 89c8d3288590f094596c772ab7d43302bfaf36cf Mon Sep 17 00:00:00 2001 From: Pierre Nicolas Date: Thu, 9 Jan 2025 11:12:15 -0500 Subject: [PATCH] fix navigation Need to use toctree. Need to use .md target. Remove non-existing links Change-Id: Iff5d1b88e5b283940fc94f919d5c82366ed62554 --- build/index.md | 8 ++++++-- contribute.md | 14 ++++++-------- index.md | 18 +++++++++++------- user/index.rst | 2 -- 4 files changed, 23 insertions(+), 19 deletions(-) diff --git a/build/index.md b/build/index.md index 4abfb1a..6b11f5e 100644 --- a/build/index.md +++ b/build/index.md @@ -10,5 +10,9 @@ This manual is for anyone looking to build Jami from source to: ## Sections -* [Introduction](introduction.md) -* [Dependencies](dependencies.md) \ No newline at end of file +```{toctree} +:maxdepth: 1 + +introduction +dependencies +``` \ No newline at end of file diff --git a/contribute.md b/contribute.md index 4f8daf9..01fc166 100644 --- a/contribute.md +++ b/contribute.md @@ -259,7 +259,7 @@ $ git add source/file/you/edited.md $ git commit ``` -Refer to the [commit message guidelines](contribute.html#commit-message-guidelines) for how to write a good commit message. +Refer to the [commit message guidelines](contribute.md#commit-message-guidelines) for how to write a good commit message. ## Submitting a change @@ -295,11 +295,9 @@ For instance, if you added a new page called `user` folder, you should add it in the `toctree` directive of `user/index.rst`, *without* the file extension: -```.. code-block:: reST - - .. toctree:: - - ... - bug-report-guide - hosting-jams-on-aws-guide +```reStructuredText +.. toctree:: + ... + bug-report-guide + hosting-jams-on-aws-guide ``` \ No newline at end of file diff --git a/index.md b/index.md index 6e3ef37..0f4e408 100644 --- a/index.md +++ b/index.md @@ -4,7 +4,7 @@ alt="«Image: Jami logo»" title="Jami logo" /> -This is the documentation for [Jami](https://jami.net), free/libre software for [universal communication](user/introduction.md) that respects the freedom and privacy of its users. +This is the documentation for [Jami](https://jami.net), free/libre software for [universal communication](user/introduction.rst) that respects the freedom and privacy of its users. Jami is available across operating systems and platforms including GNU/Linux, macOS, Windows, Android/Replicant, and iOS. Jami is an official GNU package and you can redistribute it and/or modify it under the terms of the [GNU General Public License](https://www.gnu.org/licenses/gpl.html) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. @@ -23,12 +23,16 @@ This documentation is community-driven and [anyone can contribute](contribute.md Here are the documentation manuals of Jami and details on how to contribute to Jami: -* [User manual](user/index.md) -* [JAMS manual](jams/index.md) -* [Build manual](build/index.md) -* [Developer manual](developer/index.md) -* [Extension manual](extension/index.md) -* [Contribute](contribute.md) +```{toctree} +:maxdepth: 1 + +user/index +jams/index +build/index +developer/index +extension/index +contribute +```` ## Community and support diff --git a/user/index.rst b/user/index.rst index 5da4901..35bd954 100644 --- a/user/index.rst +++ b/user/index.rst @@ -15,11 +15,9 @@ bugs and issues. introduction create-jami-account jami-distributed-network - features all-features-by-client faq lan-only - tutorials bug-report-guide ..