diff --git a/docs/README.md b/docs/README.md index d107518..c4c458a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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/ diff --git a/docs/modelists/README.md b/docs/modelists/README.md new file mode 100644 index 0000000..c897ecd --- /dev/null +++ b/docs/modelists/README.md @@ -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) diff --git a/docs/technical/README.md b/docs/technical/README.md index 9abab51..8bf1653 100644 --- a/docs/technical/README.md +++ b/docs/technical/README.md @@ -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) ----