GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2025-01-12 05:02:33 +01:00
Code Issues Projects Releases Wiki Activity

docs: relayout table of contents & links between pages

Browse Source
This commit is contained in:
James Lu 2016-05-11 21:31:11 -07:00
parent f2f945e4bb
commit ad428b55bc
3 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/README.md Normal file
View File

@ -0,0 +1,8 @@
# PyLink Documentation
This folder contains general documentation for PyLink IRC services.
## Contents
- [Opering with PyLink Relay](pylink-opers.md)
- [Developer documentation](technical/)

11
docs/technical/README.md
View File

@ -1,13 +1,13 @@
# PyLink Developer Documentation # PyLink Developer Documentation
Please note that as PyLink is still in its development phase, the API is subject to change. Please note that as PyLink is still in its development phase, its APIs are subject to change.
Any documentation here is provided for reference only. Any documentation here is provided for reference only.
It is also really incomplete (contributors welcome!) The docs are also really incomplete (contributors welcome!)
## Introduction ## Introduction
PyLink is an a modular, plugin-based IRC PseudoService framework. It uses swappable protocol modules and a hook-based system for calling plugins, allowing them to function regardless of the IRCd used. 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.
<img src="core-structure.png" width="50%" height="50%"> <img src="core-structure.png" width="50%" height="50%">
@ -15,8 +15,11 @@ PyLink is an a modular, plugin-based IRC PseudoService framework. It uses swappa
- [Writing plugins for PyLink](writing-plugins.md) - [Writing plugins for PyLink](writing-plugins.md)
- [PyLink protocol module specification](pmodule-spec.md) - [PyLink protocol module specification](pmodule-spec.md)
- [Using PyLink's utils module](using-utils.md)
- [PyLink hooks reference](hooks-reference.md) - [PyLink hooks reference](hooks-reference.md)
- [Supported named channel modes](channel-modes.csv)
- [API reference: utils.py](autogen/utils.html)
- [API reference: classes.py](autogen/classes.html)
### Future topics (not yet available) ### Future topics (not yet available)
- [Writing tests for PyLink modules](writing-tests.md) - [Writing tests for PyLink modules](writing-tests.md)
- [Supported named user modes](user-modes.csv)

2
docs/technical/pmodule-spec.md
View File

@ -147,3 +147,5 @@ Internally, modes are stored in channel and user objects as sets: `(userobj or c
``` ```
When a certain mode (e.g. owner) isn't supported on a network, the key still exists in `prefixmodes` but is simply unused. When a certain mode (e.g. owner) isn't supported on a network, the key still exists in `prefixmodes` but is simply unused.
You can see a list of supported (named) channel modes [here](channel-modes.csv).