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]
This commit is contained in:
Hornwitser committed 2020-09-21 19:57:52 +02:00
1 parent 0cca9ed22c
commit 5e410a6ac3
3 files changed
+10 -10

No files matched your search

+3 -3
View File
@@ -50,9 +50,9 @@ Message
There's two types of messages currently implemented apart from the There's two types of messages currently implemented apart from the
Link builtin close message and that's Request and Event. The builtin Link builtin close message and that's Request and Event. The builtin
messages are defined in messages are defined in
[lib/link/messages.js](/package/lib/link/messages.js) and are attached [packages/lib/link/messages.js](/packages/lib/link/messages.js) and are
to links via the attachAllMessages function, which is usally called in attached to links via the attachAllMessages function, which is usally
the Link subclass constructor. called in the Link subclass constructor.
The messages define which links they are valid on and only attaches The messages define which links they are valid on and only attaches
handlers for those links. There's also a forwarding mechanism for when handlers for those links. There's also a forwarding mechanism for when
+3 -3
View File
@@ -13,9 +13,9 @@ the startup, and the groups and their fields for disabled plugins will
still be created. still be created.
The built-in config groups and their fields are defined in The built-in config groups and their fields are defined in
[lib/config/definitions.js](/packages/lib/config/definitions.js) while [packages/lib/config/definitions.js](/packages/lib/config/definitions.js)
plugins can add their own config groups to the `MasterConfigGroup` and while plugins can add their own config groups to the `MasterConfigGroup`
`InstanceConfigGroup` properties of the `info.js` export using and `InstanceConfigGroup` properties of the `info.js` export using
subclasses of `PluginConfigGroup`. The plugin group has the enabled subclasses of `PluginConfigGroup`. The plugin group has the enabled
field pre-defined on it, and it's used to enable/disable plugins. field pre-defined on it, and it's used to enable/disable plugins.
+4 -4
View File
@@ -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` are events. The data payload of an event consists solely of
event specific properties. event specific properties.
See [lib/link/messages.js](/packages/lib/link/messages.js) for the See [packages/lib/link/messages.js](/packages/lib/link/messages.js) for
recognized events and their contents. the recognized events and their contents.
Requests 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 occured while processing the request an error response containing an
error property in the data payload is sent instead. error property in the data payload is sent instead.
See [lib/link/messages.js](/packages/lib/link/messages.js) for the See [packages/lib/link/messages.js](/packages/lib/link/messages.js) for
recognized requests and their contents. the recognized requests and their contents.
### `*_response` ### `*_response`