Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add definitions section #71

Merged
merged 1 commit into from
Nov 14, 2017
Merged

feat: add definitions section #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ _Note: This is only a navigation guide for the specification, and does not defin
- [API](#api)
- [Contribute](#contribute)
- [License](#license)
- [Definitions](#definitions)

## Sections

Expand Down Expand Up @@ -133,7 +134,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.
Expand All @@ -148,7 +149,7 @@ progressively greater amount of knowledge."
- If there is no code in the module - for instance, a document-based module - this section is not required.

### Usage
**Status:** Required by default, optional for doc modules.
**Status:** Required by default, optional for [documentation repositories](#definitions).

**Requirements:**
- Code block illustrating common usage.
Expand Down Expand Up @@ -222,3 +223,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).