summary refs log tree commit diff
path: root/Documentation/how-to.adoc
diff options
context:
space:
mode:
authorAlyssa Ross <hi@alyssa.is>2022-05-22 20:34:39 +0000
committerAlyssa Ross <hi@alyssa.is>2022-05-22 20:38:23 +0000
commitfe24a4bc605f247c23138300fcd2ed47d441d472 (patch)
tree51e06580b74f643fb4b085cc2c982f68bc56dd8b /Documentation/how-to.adoc
parent385e5c2f8773989519b2204d94e83c7f00af9d6c (diff)
downloadspectrum-fe24a4bc605f247c23138300fcd2ed47d441d472.tar
spectrum-fe24a4bc605f247c23138300fcd2ed47d441d472.tar.gz
spectrum-fe24a4bc605f247c23138300fcd2ed47d441d472.tar.bz2
spectrum-fe24a4bc605f247c23138300fcd2ed47d441d472.tar.lz
spectrum-fe24a4bc605f247c23138300fcd2ed47d441d472.tar.xz
spectrum-fe24a4bc605f247c23138300fcd2ed47d441d472.tar.zst
spectrum-fe24a4bc605f247c23138300fcd2ed47d441d472.zip
Documentation: reorganize for Diátaxis
The Diátaxis[1] framework promotes separating technical documentation
into Tutorials, How-tos, Reference, and Explanation.  Not all of our
documentation was written to be specifically one of these things, but
each documentation page has one it's closest to, so organising
everything into the proper category is a good start.  It should also
encourage the system to be followed for new documentation.

[1]: https://diataxis.fr/
Diffstat (limited to 'Documentation/how-to.adoc')
-rw-r--r--Documentation/how-to.adoc6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/how-to.adoc b/Documentation/how-to.adoc
new file mode 100644
index 0000000..f43fa13
--- /dev/null
+++ b/Documentation/how-to.adoc
@@ -0,0 +1,6 @@
+= How-to Guides
+:page-has_children: true
+:page-nav_order: 2
+
+// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0