Skip to content

Commit

Permalink
docs: add contributing page
Browse files Browse the repository at this point in the history
42willow committed Jan 27, 2025
1 parent 6e0c570 commit 255564b
Showing 2 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -25,6 +25,7 @@ export default defineConfig({
{ text: "Customisation", link: "/customisation" },
{ text: "Integrations", link: "/integrations" },
{ text: "Keyboard Shortcuts", link: "/shortcuts" },
{ text: "Contributing", link: "/contributing" },
],
},
],
33 changes: 33 additions & 0 deletions src/contributing.md
Original file line number Diff line number Diff line change
@@ -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`

<sub>Instructions adapted from [user1189731](https://superuser.com/users/1189731/user1189731)'s [post](https://superuser.com/a/1608642)</sub>

0 comments on commit 255564b

Please sign in to comment.