From 5e410a6ac3e7c73bf615b15b2d7bfae81e62eb4a Mon Sep 17 00:00:00 2001 From: Hornwitser Date: Mon, 21 Sep 2020 19:57:52 +0200 Subject: [PATCH] Use full path when referencing files in documentation Include the packages/ component in paths referenced in the documentation to make it clear where the files are located in the repository. [skip travis] --- docs/communication.md | 6 +++--- docs/config-system.md | 6 +++--- docs/socket.md | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/communication.md b/docs/communication.md index 54c75af2..bf56f4b8 100644 --- a/docs/communication.md +++ b/docs/communication.md @@ -50,9 +50,9 @@ Message There's two types of messages currently implemented apart from the Link builtin close message and that's Request and Event. The builtin messages are defined in -[lib/link/messages.js](/package/lib/link/messages.js) and are attached -to links via the attachAllMessages function, which is usally called in -the Link subclass constructor. +[packages/lib/link/messages.js](/packages/lib/link/messages.js) and are +attached to links via the attachAllMessages function, which is usally +called in the Link subclass constructor. The messages define which links they are valid on and only attaches handlers for those links. There's also a forwarding mechanism for when diff --git a/docs/config-system.md b/docs/config-system.md index dd7a1b30..058dba45 100644 --- a/docs/config-system.md +++ b/docs/config-system.md @@ -13,9 +13,9 @@ the startup, and the groups and their fields for disabled plugins will still be created. The built-in config groups and their fields are defined in -[lib/config/definitions.js](/packages/lib/config/definitions.js) while -plugins can add their own config groups to the `MasterConfigGroup` and -`InstanceConfigGroup` properties of the `info.js` export using +[packages/lib/config/definitions.js](/packages/lib/config/definitions.js) +while plugins can add their own config groups to the `MasterConfigGroup` +and `InstanceConfigGroup` properties of the `info.js` export using subclasses of `PluginConfigGroup`. The plugin group has the enabled field pre-defined on it, and it's used to enable/disable plugins. diff --git a/docs/socket.md b/docs/socket.md index 3e1acd27..8e28705d 100644 --- a/docs/socket.md +++ b/docs/socket.md @@ -230,8 +230,8 @@ there's [Requests](#requests). By convention message types ending in `*_event` are events. The data payload of an event consists solely of event specific properties. -See [lib/link/messages.js](/packages/lib/link/messages.js) for the -recognized events and their contents. +See [packages/lib/link/messages.js](/packages/lib/link/messages.js) for +the recognized events and their contents. Requests @@ -245,8 +245,8 @@ replied to with a corresponding `*_response` message. If an error occured while processing the request an error response containing an error property in the data payload is sent instead. -See [lib/link/messages.js](/packages/lib/link/messages.js) for the -recognized requests and their contents. +See [packages/lib/link/messages.js](/packages/lib/link/messages.js) for +the recognized requests and their contents. ### `*_response`