From a730abb8f4fd312d4d008827f40f529be306fc57 Mon Sep 17 00:00:00 2001 From: Zoffix Znet Date: Fri, 29 Jul 2016 17:33:07 -0400 Subject: Doc fixup --- README.md | 13 ++++++++----- docs/01-basics.md | 2 +- docs/02-event-reference.md | 2 +- docs/03-method-reference.md | 2 +- docs/04-big-picture-behaviour.md | 2 +- docs/README.md | 9 +++++++++ 6 files changed, 21 insertions(+), 9 deletions(-) create mode 100644 docs/README.md diff --git a/README.md b/README.md index 7291c16..8970dcc 100644 --- a/README.md +++ b/README.md @@ -33,26 +33,29 @@ and output post-processing. # DOCUMENTATION MAP +* [Blog Post](#not-published) * [Basics Tutorial](docs/01-basics.md) -* [Event reference](docs/02-event-reference.md) +* [Event Reference](docs/02-event-reference.md) +* [Method Reference](docs/03-method-reference.md) +* [Big-Picture Behaviour](docs/04-big-picture-behaviour.md) --- -# REPOSITORY +#### REPOSITORY Fork this module on GitHub: https://github.com/zoffixznet/perl6-IRC-Client -# BUGS +#### BUGS To report bugs or request features, please use https://github.com/zoffixznet/perl6-IRC-Client/issues -# AUTHOR +#### AUTHOR Zoffix Znet (http://zoffix.com/) -# LICENSE +#### LICENSE You can use and distribute this module under the terms of the The Artistic License 2.0. See the `LICENSE` file included in this diff --git a/docs/01-basics.md b/docs/01-basics.md index 36ae32f..5aabaca 100644 --- a/docs/01-basics.md +++ b/docs/01-basics.md @@ -1,4 +1,4 @@ -[[back to main docs]](../README.md#documentation-map) +[[back to doc map]](README.md) # Basics Tutorial diff --git a/docs/02-event-reference.md b/docs/02-event-reference.md index 20aa870..3e43ca0 100644 --- a/docs/02-event-reference.md +++ b/docs/02-event-reference.md @@ -1,4 +1,4 @@ -[[back to main docs]](../README.md#documentation-map) +[[back to doc map]](README.md) # Event Reference diff --git a/docs/03-method-reference.md b/docs/03-method-reference.md index 9221474..daddbfc 100644 --- a/docs/03-method-reference.md +++ b/docs/03-method-reference.md @@ -1,4 +1,4 @@ -[[back to main docs]](../README.md#documentation-map) +[[back to doc map]](README.md) # Method Reference diff --git a/docs/04-big-picture-behaviour.md b/docs/04-big-picture-behaviour.md index f655eb9..19f5ae7 100644 --- a/docs/04-big-picture-behaviour.md +++ b/docs/04-big-picture-behaviour.md @@ -1,4 +1,4 @@ -[[back to main docs]](../README.md#documentation-map) +[[back to doc map]](README.md) # Big-Picture Behaviour diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..7a30874 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,9 @@ +[[back to main docs]](../README.md) + +# Documentation Map + +* [Blog Post](#not-published) +* [Basics Tutorial](docs/01-basics.md) +* [Event Reference](docs/02-event-reference.md) +* [Method Reference](docs/03-method-reference.md) +* [Big-Picture Behaviour](docs/04-big-picture-behaviour.md) -- cgit v1.1