contrapunctus
/
docspec
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Mention the four kinds of documentation

This commit is contained in:
contrapunctus 2022-01-22 01:27:21 +05:30
parent 56b0667041
commit 5040f2684f
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.org
View File

@ -1,6 +1,6 @@
#+TITLE: DocSpec
DocSpec provides a standard, predictable interface to access the [[https://diataxis.fr/][four different types of documentation]].
DocSpec provides a standard, predictable interface to access the [[https://diataxis.fr/][four different types of documentation]] for a project - tutorials (lessons), how-to guides (recipes), explanation (discussion), and reference (technical description).
DocSpec is
1. a configuration file in your project root, specifying how to reach sections of your documentation, and associating symbols with them if desired