mirror of
https://github.com/jlu5/PyLink.git
synced 2024-12-25 04:02:45 +01:00
Initial documentation stub (docs/technical/)
This commit is contained in:
parent
d23d1c3987
commit
e91efa5a6c
14
docs/technical/README.md
Normal file
14
docs/technical/README.md
Normal file
@ -0,0 +1,14 @@
|
||||
## PyLink Developer Documentation
|
||||
|
||||
Please note that as PyLink is still in its development phase, the API is subject to change.
|
||||
Any documentation here is provided for reference only.
|
||||
|
||||
### Introduction
|
||||
|
||||
PyLink is a modular, plugin-based IRC PseudoService framework. It uses swappable protocol modules and a hook-based system for calling plugins, which aim, together, to provide a consistent API.
|
||||
|
||||
![Diagram of PyLink's core structure](core-structure.png)
|
||||
|
||||
### Contents
|
||||
|
||||
TBD.
|
6
docs/technical/core-structure.dot
Normal file
6
docs/technical/core-structure.dot
Normal file
@ -0,0 +1,6 @@
|
||||
digraph G {
|
||||
IRCd -> "Protocol module" -> "PyLink Core" -> "PyLink hooks" -> Plugins;
|
||||
Plugins -> "Protocol module" [label="Communicates via\n*Client/*Server API\ncommands"] [color=navyblue] [fontcolor=navyblue];
|
||||
Plugins -> "PyLink Core" [label="Adds commands &\nhook handlers via\nutils.add_cmd/add_hook"] [color=brown] [fontcolor=brown];
|
||||
"Protocol module" -> IRCd;
|
||||
}
|
BIN
docs/technical/core-structure.png
Normal file
BIN
docs/technical/core-structure.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 49 KiB |
Loading…
Reference in New Issue
Block a user