Skip to content

Commit

Permalink
Update doc-plan.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jabba-jedi committed Jun 10, 2020
1 parent c8ea27a commit 3e66187
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/doc-plan.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
# SigTest Documentation plan

- [SigTest Documentation plan](#sigtest-documentation-plan)
- [Overview aka What this lib does](#overview-aka-what-this-lib-does)
- [Why you need it](#why-you-need-it)
- [What it doesn't do](#what-it-doesnt-do)
- [Configuration](#configuration)
- [Configure Service Provided Interface (SPI) parameters](#configure-service-provided-interface-spi-parameters)
- [Configure members to ignore](#configure-members-to-ignore)
- [Global config](#global-config)
- [comparators](#comparators)
- [pathIgnorePatterns](#pathignorepatterns)
- [reportOutputDir](#reportoutputdir)
- [reportGenerator](#reportgenerator)
- [Usage](#usage)
- [Reference aka How it works](#reference-aka-how-it-works)
- [Testing flow](#testing-flow)
- [Supported members](#supported-members)
- [Comparators](#comparators-1)
- [Error codes](#error-codes)

## Overview aka What this lib does

This library is excellent for:
Expand Down

0 comments on commit 3e66187

Please sign in to comment.