From 58b717a2a0178f283981b04eeb18bb1e34132e85 Mon Sep 17 00:00:00 2001 From: James Lu Date: Sat, 13 Jan 2018 18:28:41 -0800 Subject: [PATCH] docs/t: warn in main articles that specifications in master may be outdated [skip ci] --- docs/technical/hooks-reference.md | 3 +++ docs/technical/pmodule-spec.md | 3 +++ docs/technical/writing-plugins.md | 3 +++ 3 files changed, 9 insertions(+) diff --git a/docs/technical/hooks-reference.md b/docs/technical/hooks-reference.md index 9038fe7..d2c60b3 100644 --- a/docs/technical/hooks-reference.md +++ b/docs/technical/hooks-reference.md @@ -1,3 +1,6 @@ +### Version Warning +This version of the document targets the current stable branch of PyLink, and may be considerably outdated when compared to the **devel** branch where active development takes place. When developing new plugins or protocol modules, we highly recommend targeting the devel branch. + # PyLink hooks reference ***Last updated for 1.2-dev (2017-02-24).*** diff --git a/docs/technical/pmodule-spec.md b/docs/technical/pmodule-spec.md index 85fd6cc..445d49e 100644 --- a/docs/technical/pmodule-spec.md +++ b/docs/technical/pmodule-spec.md @@ -1,3 +1,6 @@ +### Version Warning +This version of the document targets the current stable branch of PyLink, and may be considerably outdated when compared to the **devel** branch where active development takes place. When developing new plugins or protocol modules, we highly recommend targeting the devel branch. + # PyLink Protocol Module Specification ***Last updated for 1.2-dev (2017-03-15).*** diff --git a/docs/technical/writing-plugins.md b/docs/technical/writing-plugins.md index 649fb0e..eb5e74b 100644 --- a/docs/technical/writing-plugins.md +++ b/docs/technical/writing-plugins.md @@ -1,3 +1,6 @@ +### Version Warning +This version of the document targets the current stable branch of PyLink, and may be considerably outdated when compared to the **devel** branch where active development takes place. When developing new plugins or protocol modules, we highly recommend targeting the devel branch. + # Writing plugins for PyLink PyLink plugins are modules that extend its functionality by giving it something to do. Without any plugins loaded, PyLink can only sit on a server and do absolutely nothing.