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

Present benefits as list

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

4
README.org
View File

@ -8,7 +8,9 @@ DocSpec is
3. a command line client built on the library
4. an Emacs package, providing a =completing-read= interface
It is hoped that providing such a tool will not only make life easier for users of (DocSpec-using) projects, but also make more projects aware of the [[https://diataxis.fr/][Diataxis Framework]], helping them make their documentation easier to read and maintain.
It is hoped that this tool will -
1. make documentation more accessible to users, and
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
Below is what an example DocSpec file for the [[https://github.com/McCLIM/McCLIM/][McCLIM]] project might look like.