3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-28 21:52:38 +01:00
PyLink/docs/README.md
James Lu 86b93ea969 docs: rewrite the Relay Quick Start Guide (#619)
- Rename pylink-opers.md -> relay-quickstart.md to better reflect its contents.
- Add a section regarding services compatibility and which features _not_ to use with Relay
- Document LINKACL whitelists, CHANDESC, CLAIM/LINKACL options introduced in 2.0
- Document reworked KILL handling in 2.0 and why K/G/ZLINE support hasn't been implemented
- Explain Relay concepts in more depth for people not familiar with Janus
2018-07-08 12:30:57 -07:00

24 lines
659 B
Markdown

# PyLink Documentation
This folder contains general documentation for PyLink IRC services.
## Contents
- [PyLink FAQ (Frequently Asked Questions)](faq.md)
- [PyLink Relay Quick Start Guide](relay-quickstart.md)
----
- [Automode Tutorial](automode.md)
- [Advanced Relay Configuration](advanced-relay-config.md)
- [Advanced Services Configuration](advanced-services-config.md)
- [Extended Targets (Exttargets) Guide](exttargets.md)
- [PyLink Permissions Reference](permissions-reference.md)
----
- [PyLink named modes tables](modelists/)
- [Developer documentation](technical/)
There is also a Doxygen-powered API reference at https://pylink.github.io/