diff --git a/spec.md b/spec.md index dd224e2..c11f349 100644 --- a/spec.md +++ b/spec.md @@ -30,6 +30,7 @@ _Note: This is only a navigation guide for the specification, and does not defin - [API](#api) - [Contribute](#contribute) - [License](#license) +- [Definitions](#definitions) ## Sections @@ -129,7 +130,7 @@ progressively greater amount of knowledge." - Cover intellectual provenance: A `See Also` section is also fitting. ### Install -**Status:** Required by default, optional for doc modules. +**Status:** Required by default, optional for [documentation repositories](#definitions). **Requirements:** - Code block illustrating how to install. @@ -144,7 +145,7 @@ progressively greater amount of knowledge." - An `Updating` section would be useful for most packages, if there are multiple versions which the user may interface with. ### Usage -**Status:** Required by default, optional for doc modules. +**Status:** Required by default, optional for [documentation repositories](#definitions). **Requirements:** - Code block illustrating common usage. @@ -218,3 +219,9 @@ progressively greater amount of knowledge." **Suggestions:** - Link to longer License file in local repository. + +## Definitions + +_These definitions are provided to clarify any terms used above._ + +- **Documentation repositories**: Repositories without any functional code. For instance, [RichardLitt/knowledge](https://github.com/RichardLitt/knowledge).