From 20f2673d7098f8ff83c35ce23d7a033820d46fdd Mon Sep 17 00:00:00 2001 From: Zach Mitchell Date: Thu, 13 Apr 2023 21:50:10 -0400 Subject: [PATCH] Add recipes, reference, and contributing sections --- .../{index.md => how-to-contribute.md} | 7 ---- source/index.md | 37 +++++++++++++++++-- source/{ => recipes}/faq.md | 0 source/{ => reference}/glossary.md | 0 source/reference/index.md | 10 ----- 5 files changed, 33 insertions(+), 21 deletions(-) rename source/contributing/{index.md => how-to-contribute.md} (97%) rename source/{ => recipes}/faq.md (100%) rename source/{ => reference}/glossary.md (100%) delete mode 100644 source/reference/index.md diff --git a/source/contributing/index.md b/source/contributing/how-to-contribute.md similarity index 97% rename from source/contributing/index.md rename to source/contributing/how-to-contribute.md index a48e612..e5fdc8c 100644 --- a/source/contributing/index.md +++ b/source/contributing/how-to-contribute.md @@ -1,12 +1,5 @@ # How to Contribute -```{toctree} -:hidden: true - -documentation.md -writing-a-tutorial.md -``` - This guide explains how you can contribute to Nix, Nix packages or NixOS. diff --git a/source/index.md b/source/index.md index dce19ff..7741e77 100644 --- a/source/index.md +++ b/source/index.md @@ -36,10 +36,39 @@ and [NixOps](http://nixos.org/nixops/manual/) manuals. tutorials/index.md templates/index.md anti-patterns/index.md -reference/index.md -faq.md recommended-reading.md influences.md -glossary.md -contributing/index.md ``` + +```{toctree} +:glob: +:caption: Recipes +:maxdepth: 1 +:hidden: + +recipes/* +``` + +```{toctree} +:glob: +:caption: Reference +:maxdepth: 1 +:hidden: + +reference/pinning-nixpkgs.md +reference/glossary.md +Nixpkgs Manual +NixOS Manual +Nix Reference Manual +``` + +```{toctree} +:glob: +:caption: Contributing +:maxdepth: 1 +:hidden: + +contributing/how-to-contribute.md +contributing/documentation.md +contributing/writing-a-tutorial.md +``` \ No newline at end of file diff --git a/source/faq.md b/source/recipes/faq.md similarity index 100% rename from source/faq.md rename to source/recipes/faq.md diff --git a/source/glossary.md b/source/reference/glossary.md similarity index 100% rename from source/glossary.md rename to source/reference/glossary.md diff --git a/source/reference/index.md b/source/reference/index.md deleted file mode 100644 index 7caa53d..0000000 --- a/source/reference/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# Reference - -This section contains articles which are supplementary to the [tutorials](../tutorials/index.md). - -```{toctree} -:glob: true -:maxdepth: 1 - -pinning-nixpkgs.md -```