3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-23 19:19:31 +01:00

docs: update table of contents

Mode lists are in a separate folder now.

[skip ci]
This commit is contained in:
James Lu 2017-10-05 19:04:09 -07:00
parent 82a6ceb99e
commit 5574c746b9
3 changed files with 8 additions and 5 deletions

View File

@ -17,6 +17,7 @@ This folder contains general documentation for PyLink IRC services.
----
- [PyLink named modes tables](modelists/)
- [Developer documentation](technical/)
There is also a Doxygen-powered API reference at https://pylink.github.io/

4
docs/modelists/README.md Normal file
View File

@ -0,0 +1,4 @@
This folder contains tables of named modes defined by PyLink modules. The following are HTML versions of the raw .csv data:
- [Supported named channel modes](https://raw.githack.com/GLolol/PyLink/devel/docs/modelists/channel-modes.html)
- [Supported named user modes](https://raw.githack.com/GLolol/PyLink/devel/docs/modelists/user-modes.html)

View File

@ -1,9 +1,9 @@
# PyLink Developer Documentation
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.
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 (contributors welcome!)
The docs are also really incomplete (contributions are appreciated!)
## Introduction
@ -20,8 +20,6 @@ PyLink is an a modular, plugin-based IRC services framework. It uses swappable p
----
- [PyLink protocol module specification](pmodule-spec.md)
- [Supported named channel modes](https://raw.githack.com/GLolol/PyLink/devel/docs/modelists/channel-modes.html)
- [Supported named user modes](https://raw.githack.com/GLolol/PyLink/devel/docs/modelists/user-modes.html)
----