mirror of
https://github.com/jlu5/PyLink.git
synced 2024-11-30 14:49:28 +01:00
docs: update table of contents
Mode lists are in a separate folder now. [skip ci]
This commit is contained in:
parent
82a6ceb99e
commit
5574c746b9
@ -17,6 +17,7 @@ This folder contains general documentation for PyLink IRC services.
|
|||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
|
- [PyLink named modes tables](modelists/)
|
||||||
- [Developer documentation](technical/)
|
- [Developer documentation](technical/)
|
||||||
|
|
||||||
There is also a Doxygen-powered API reference at https://pylink.github.io/
|
There is also a Doxygen-powered API reference at https://pylink.github.io/
|
||||||
|
4
docs/modelists/README.md
Normal file
4
docs/modelists/README.md
Normal 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)
|
@ -1,9 +1,9 @@
|
|||||||
# PyLink Developer Documentation
|
# PyLink Developer Documentation
|
||||||
|
|
||||||
Please note that as PyLink is still in its development phase, its APIs are subject to change.
|
This documentation is provided for reference only, and may not always be up to date as APIs change.
|
||||||
Any documentation here is provided for reference only.
|
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
|
## 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)
|
- [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)
|
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user