PyLink/docs/technical/README.md

# PyLink Developer Documentation

This documentation is provided for reference only, and may not always be up to date as APIs change.
Patches are welcome if something looks wrong or *is* wrong. In such cases, consulting the source code is probably your best bet.

The docs are also really incomplete (contributions are appreciated!)

## Introduction

PyLink is an a modular, plugin-based IRC services framework. It uses swappable protocol modules and a hooks system for calling plugins, allowing them to function regardless of the IRCd used.

## Contents

- [Writing plugins for PyLink](writing-plugins.md)
- [PyLink hooks reference](hooks-reference.md)
- [Services bot API/Creating your own service bots](services-api.md)
- [Permissions API Introduction](permissions-api.md)
- [Using `utils.IRCParser()`](using-ircparser.md)

----

- [PyLink protocol module specification](pmodule-spec.md)

----

- [Release Process for PyLink](release-process.md)

![Graph of protocol module inheritance tree](protocol-modules.svg)
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-26 16:44:22 -08:00			`# PyLink Developer Documentation`
Initial documentation stub (docs/technical/) 2015-08-05 23:31:53 -07:00
docs: update table of contents Mode lists are in a separate folder now. [skip ci] 2017-10-05 19:04:09 -07:00			`This documentation is provided for reference only, and may not always be up to date as APIs change.`
			`Patches are welcome if something looks wrong or is wrong. In such cases, consulting the source code is probably your best bet.`
Initial documentation stub (docs/technical/) 2015-08-05 23:31:53 -07:00
docs: update table of contents Mode lists are in a separate folder now. [skip ci] 2017-10-05 19:04:09 -07:00			`The docs are also really incomplete (contributions are appreciated!)`
docs: add auto-generated InspIRCd protocol spec, and finish off most of writing-plugins.md 2015-09-06 23:11:31 -07:00
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-26 16:44:22 -08:00			`## Introduction`
Initial documentation stub (docs/technical/) 2015-08-05 23:31:53 -07:00
docs: relayout table of contents & links between pages 2016-05-11 21:31:11 -07:00			`PyLink is an a modular, plugin-based IRC services framework. It uses swappable protocol modules and a hooks system for calling plugins, allowing them to function regardless of the IRCd used.`
Initial documentation stub (docs/technical/) 2015-08-05 23:31:53 -07:00
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-26 16:44:22 -08:00			`## Contents`
Initial documentation stub (docs/technical/) 2015-08-05 23:31:53 -07:00
docs/: fill in Contents, where future docs will go 2015-08-09 14:36:46 +08:00			`- [Writing plugins for PyLink](writing-plugins.md)`
docs: add auto-generated InspIRCd protocol spec, and finish off most of writing-plugins.md 2015-09-06 23:11:31 -07:00			`- [PyLink hooks reference](hooks-reference.md)`
docs: document the permissions API for developers Closes #368. 2016-12-25 11:17:10 -08:00			`- [Services bot API/Creating your own service bots](services-api.md)`
			`- [Permissions API Introduction](permissions-api.md)`
docs/t: link to using-ircparser.md in contents 2017-03-12 20:38:58 -07:00			- [Using `utils.IRCParser()`](using-ircparser.md)
docs: document the permissions API for developers Closes #368. 2016-12-25 11:17:10 -08:00
			`----`

			`- [PyLink protocol module specification](pmodule-spec.md)`

			`----`

Document the PyLink release process 2016-09-16 22:01:10 -07:00			`- [Release Process for PyLink](release-process.md)`
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-26 16:44:22 -08:00
Convert protocol-modules graphic to a .svg 2017-11-12 12:07:08 -08:00			`![Graph of protocol module inheritance tree](protocol-modules.svg)`