From c0a69d7d084506e2f2ad3ceb2a84844bef610cd0 Mon Sep 17 00:00:00 2001 From: Conor Kirby <67641390+ckirby19@users.noreply.github.com> Date: Mon, 22 Jan 2024 16:49:08 +0000 Subject: [PATCH] [Docs]Add file for MWB documentation (#30838) * Added markdown file for mouse without borders documentation * Changed wording from codes to colors * Reformatted hex codes following comment * Added mousewithoutborders to github allow names --- .github/actions/spell-check/allow/names.txt | 1 + doc/devdocs/modules/mousewithoutborders.md | 22 +++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 doc/devdocs/modules/mousewithoutborders.md diff --git a/.github/actions/spell-check/allow/names.txt b/.github/actions/spell-check/allow/names.txt index 0ebacd1b41..19ee645a9f 100644 --- a/.github/actions/spell-check/allow/names.txt +++ b/.github/actions/spell-check/allow/names.txt @@ -7,6 +7,7 @@ imageresizer kbm keyboardmanager markdownpreviewhandler +mousewithoutborders mwb oobe pasteplain diff --git a/doc/devdocs/modules/mousewithoutborders.md b/doc/devdocs/modules/mousewithoutborders.md new file mode 100644 index 0000000000..3a8f981087 --- /dev/null +++ b/doc/devdocs/modules/mousewithoutborders.md @@ -0,0 +1,22 @@ +# Mouse Without Borders module +This file contains the documentation for the Mouse Without Borders PowerToy module. +## Table of Contents: +- [Mouse Without Borders module](#mouse-without-borders-module) + - [Table of Contents](#table-of-contents) + - [Status colors](#status-colors) + +## Status colors +The following colors are used to indicate the connection status to the user when trying to connect to another computer: + +| Connection Status | Color | Hex Code | +| :-----: | :---: | :---: | +| NA | Dark Grey | `#00717171` | +| Resolving | Yellow | `#FFFFFF00` | +| Connecting | Orange | `#FFFFA500` | +| Handshaking | Blue | `#FF0000FF` | +| Error | Red | `#FFFF0000` | +| ForceClosed | Purple | `#FF800080` | +| InvalidKey | Brown | `#FFA52A2A` | +| Timeout | Pink | `#FFFFC0CB` | +| SendError | Maroon | `#FF800000` | +| Connected | Green | `#FF008000` |