From 255564b1e5a46ce9d43b55bfd50a90fdfb63667f Mon Sep 17 00:00:00 2001 From: willow <42willow@pm.me> Date: Tue, 28 Jan 2025 10:48:11 +1100 Subject: [PATCH] docs: add contributing page --- .vitepress/config.mts | 1 + src/contributing.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 src/contributing.md diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 76a1389..7a5093c 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -25,6 +25,7 @@ export default defineConfig({ { text: "Customisation", link: "/customisation" }, { text: "Integrations", link: "/integrations" }, { text: "Keyboard Shortcuts", link: "/shortcuts" }, + { text: "Contributing", link: "/contributing" }, ], }, ], diff --git a/src/contributing.md b/src/contributing.md new file mode 100644 index 0000000..60cdd16 --- /dev/null +++ b/src/contributing.md @@ -0,0 +1,33 @@ +--- +outline: false +--- + +# Contributing + +If you want to get your change merged into the main project, please follow the [contribution guidelines](https://github.com/cascadefox/cascade/blob/main/contributing.md) + +## Inspecting the browser window + +To inspect Firefox's UI you can use the [Browser Toolbox](https://developer.mozilla.org/en-US/docs/Tools/Browser_Toolbox). + +### Enable the Browser Toolbox + +1. Press `F12` to open the Page Inspector. + + **Alternate:** Right click the page then "Inspect Element (Q)". + +2. Press `F1` to open the Page Inspector Settings. + + **Alternate:** In the top right of the Page Inspector next to the close button; press the "⋯" button then "Settings". + +3. Ensure the following settings are checked: + - "Enable browser chrome and add-on debugging toolbox" + - "Enable remote debugging" + +### Open the Browser Toolbox + +Press `alt`, "Tools", "Browser Tools" then "Browser Toolbox". + +**Alternate:** Press `ctrl` + `alt` + `shift` + `i` + +Instructions adapted from [user1189731](https://superuser.com/users/1189731/user1189731)'s [post](https://superuser.com/a/1608642)