diff options
| author | Zoffix Znet <cpan@zoffix.com> | 2016-08-10 08:57:48 -0400 |
|---|---|---|
| committer | Zoffix Znet <cpan@zoffix.com> | 2016-08-10 08:57:48 -0400 |
| commit | eaeb33a484d8e8879405ca9ab1968e8efbd2f9ca (patch) | |
| tree | 1a57291e9779c5c0b7265ca8830c0b9a58496d66 | |
| parent | 5fefbef2308fb5b2beea1fe938696f79d74c66c0 (diff) | |
Improve toc layout
| -rw-r--r-- | docs/01-basics.md | 8 | ||||
| -rw-r--r-- | docs/02-event-reference.md | 8 | ||||
| -rw-r--r-- | docs/03-method-reference.md | 14 | ||||
| -rw-r--r-- | docs/04-big-picture-behaviour.md | 12 |
4 files changed, 25 insertions, 17 deletions
diff --git a/docs/01-basics.md b/docs/01-basics.md index 2af95c6..fb837de 100644 --- a/docs/01-basics.md +++ b/docs/01-basics.md @@ -1,7 +1,9 @@ [[back to doc map]](README.md) -# TABLE OF CONTENTS -- [Basics Tutorial](#basics-tutorial) +# Basics Tutorial + +## Table of Contents + - [Blog Tutorial](#blog-tutorial) - [Subscribing to Events](#subscribing-to-events) - [Event Handler Input](#event-handler-input) @@ -10,7 +12,7 @@ - [Generating Messages](#generating-messages) - [Up Next](#up-next) -# Basics Tutorial +---- This tutorial covers basic usage of `IRC::Client`, without going into [all of the supported events](02-event-reference.md) or describing diff --git a/docs/02-event-reference.md b/docs/02-event-reference.md index 5d841a5..a2c6fdd 100644 --- a/docs/02-event-reference.md +++ b/docs/02-event-reference.md @@ -1,7 +1,9 @@ [[back to doc map]](README.md) -# TABLE OF CONTENTS -- [Event Reference](#event-reference) +# Event Reference + +## Table of Contents + - [Responding to Events](#responding-to-events) - [Event Map](#event-map) - [Event Triggers](#event-triggers) @@ -29,7 +31,7 @@ - [`irc-XXX`](#irc-xxx) - [Up Next](#up-next) -# Event Reference +--- The module offers named, numeric, and convenience events. The named and numeric events correspond to IRC protocol events, while convenience events diff --git a/docs/03-method-reference.md b/docs/03-method-reference.md index 2d27a82..baecb4c 100644 --- a/docs/03-method-reference.md +++ b/docs/03-method-reference.md @@ -1,7 +1,12 @@ [[back to doc map]](README.md) -# TABLE OF CONTENTS -- [Method Reference](#method-reference) +# Method Reference + +This document describes events available on various objects in use when working +with `IRC::Client`. + +## Table of Contents + - [Message Objects (`IRC::Client::Message` and subclasses)](#message-objects-ircclientmessage-and-subclasses) - [Message Object Hierarchy](#message-object-hierarchy) - [Methods and Attributes](#methods-and-attributes) @@ -93,10 +98,7 @@ - [`.send`](#send) - [Up Next](#up-next) -# Method Reference - -This document describes events available on various objects in use when working -with `IRC::Client`. +--- ## Message Objects (`IRC::Client::Message` and subclasses) diff --git a/docs/04-big-picture-behaviour.md b/docs/04-big-picture-behaviour.md index ad48211..1f67b84 100644 --- a/docs/04-big-picture-behaviour.md +++ b/docs/04-big-picture-behaviour.md @@ -1,14 +1,16 @@ [[back to doc map]](README.md) -# TABLE OF CONTENTS -- [Big-Picture Behaviour](#big-picture-behaviour) -- [Connection Maintenance](#connection-maintenance) -- [Nickname Maintenance](#nickname-maintenance) - # Big-Picture Behaviour This document describes the general behaviour of the `IRC::Client` clients. +## Table of Contents + +- [Connection Maintenance](#connection-maintenance) +- [Nickname Maintenance](#nickname-maintenance) + +--- + ## Connection Maintenance The client is designed with the goal of being run indefinitely. As such, it |