diff --git a/README.org b/README.org index 91826df..bfc5db3 100644 --- a/README.org +++ b/README.org @@ -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=.