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

Place format description under Explanation

This commit is contained in:
contrapunctus 2022-01-23 16:36:59 +05:30
parent 94db8e73fb
commit fdd01bbc51
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.org
View File

@ -18,7 +18,8 @@ It is hoped that these tools will
1. make documentation more accessible to users
2. make more projects aware of the [[https://diataxis.fr/][Diataxis Framework]], and incentivize them to structure their documentation according to its suggestions, which in turn would make their documentation easier to read, write, and maintain.
* Creating the file
* Explanation
** The DocSpec format
Below is what an example DocSpec file for the [[https://github.com/McCLIM/McCLIM/][McCLIM]] project might look like.
Each DocSpec file can list up to four types of documentation as symbols - =tutorial=, =howto=, =explanation=, and =reference=.