Skip to content

Commit

Permalink
Fix typos throughout User Guides and update some outdated information (
Browse files Browse the repository at this point in the history
…#18)

* Remove outdated info and fix typos from configuration.md

Fixes some typos and removes all the outdated settings that are no longer in BetterDiscord.

* Fix typos in installation.mdx

Just fixes a small typo

* Fix typos in troubleshooting.md

Fix typos

* Typos fixed in index.md

fix typos found in index.md

* Fix typo installing-addons.md

* Fix typos in vanilla.mdx

* Update docs/users/getting-started/installation.mdx

Co-authored-by: Zerebos <rauenzi@outlook.com>

* Update docs/users/getting-started/configuration.md

Co-authored-by: Zerebos <rauenzi@outlook.com>

* Update docs/users/getting-started/configuration.md

Co-authored-by: Zerebos <rauenzi@outlook.com>

* Update docs/users/getting-started/configuration.md

Co-authored-by: Zerebos <rauenzi@outlook.com>

* Update vanilla.mdx

* Update index.md

* Update configuration.md

---------

Co-authored-by: Zerebos <rauenzi@outlook.com>
  • Loading branch information
Duve3 and zerebos committed Aug 21, 2023
1 parent c7b15c7 commit 732f1c9
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 37 deletions.
31 changes: 13 additions & 18 deletions docs/users/getting-started/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,9 @@ BetterDiscord has a number of settings and options for you to adjust your experi

These are settings that control whole modules of BetterDiscord.

### Emote System

This option allows you to toggle the Twitch emote system on or off. If you don't use it, it's good to leave this off as it saves your computer some RAM and CPU power.

### Public Servers

This option shows or hides the Public Servers button. If you don't use it, feel free to turn it off.

### Voice Disconnect

This option causes you to disconnect from a voice call when you close Discord. By default Discord will try to auto-reconnect you which can be annoying to some.
This option causes you to disconnect from a voice call when you close Discord. By default, Discord will try to auto-reconnect you which can be annoying to some.

### Show Toasts

Expand Down Expand Up @@ -51,12 +43,15 @@ This option determines what should happen when you click the edit button on an a

### Custom CSS

This option allows you to completely disable the custom css system. If you don't use it, turning this off saves you a bit of RAM and CPU power.
This option allows you to completely disable the custom CSS system. If you don't use it, turning this off saves you a bit of RAM and CPU power.

### Live Update

This options lets the css editor update as you type rather than waiting for you to click the button.
This option lets the CSS editor update as you type rather than waiting for you to click the button.

### Editor Location

This option determines which editor should open when editing custom CSS.


## Editor Preferences
Expand All @@ -69,11 +64,11 @@ This option simply determines whether or not line numbers should be shown.

### Minimap

This option determines if the minimap that represents the code on the right had side should be hidden or shown.
This option determines if the minimap that represents the code on the right-hand side should be hidden or shown.

### Reference Tooltips

This option shows tooltips when hovering over parts of your code. For CSS this would be selector information. For JavaScript this would be variable information.
This option shows tooltips when hovering over parts of your code. For CSS, this would be selector information. For JavaScript, this would be variable information.

### Quick Suggestions

Expand All @@ -95,11 +90,11 @@ Settings related to the main window of Discord.

### Enable Transparency

This option enables Electron's transparency mode. By itself this option doesn't do much, but if you have a theme that changes the opacity of the root element, you can actually see through the Discord client to your desktop. On Windows, having this enabled breaks aero snapping and other common window features. This is a limitation of Electron itself and not something BetterDiscord can fix.
This option enables Electron's transparency mode. By itself, this option doesn't do much, but if you have a theme that changes the opacity of the root element, you can actually see through the Discord client to your desktop. On Windows, having this enabled breaks aero snapping and other common window features. This is a limitation of Electron itself and not something BetterDiscord can fix.

### Remove Minimum Size

This option gets rid of Discord's forced minimum window size. For many users this limit is too large to be able to customize their viewscreen.
This option gets rid of Discord's forced minimum window size. For many users, this limit is too large to be able to customize their viewscreen.



Expand All @@ -113,7 +108,7 @@ This option causes BetterDiscord to output everything from the chromium console

### DevTools

This option allows you to open the chromium devtools with the usually `ctrl`+`shift`+`i` combination. If you're not a developer, best to leave this off.
This option allows you to open the chromium devtools with the usual `ctrl`+`shift`+`i` combination. If you're not a developer, best to leave this off.

### Debugger Hotkey

Expand All @@ -125,8 +120,8 @@ This option allows you to add RDT to Discord. Currently, it is required that you

### Inspect Element Hotkey

This option adds a new keybind `ctrl`+`shift`+`c` that opens DevTools and starts selecting element. If DevTools are open it immediately activates the select element action.
This option adds a new keybind `ctrl`+`shift`+`c` that opens DevTools and starts selecting elements. If DevTools are open it immediately activates the select element action.

### Stop DevTools Warning

This option stops Discord from printing out those large warnings you see in console.
This option stops Discord from printing out those large warnings you see in the console.
4 changes: 2 additions & 2 deletions docs/users/getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ pnpm install

#### 4. Build BetterDiscord

This will create a `injector.js`, `preload.js`, and `renderer.js` in the `dist/` folder.
This will create an `injector.js`, `preload.js`, and `renderer.js` in the `dist/` folder.
```bash
pnpm build
```
Expand All @@ -92,4 +92,4 @@ import CodeBlock from '@theme/CodeBlock';
<TabItem value="stable"><CodeBlock language="bash">pnpm inject</CodeBlock></TabItem>
<TabItem value="canary"><CodeBlock language="bash">pnpm inject canary</CodeBlock></TabItem>
<TabItem value="ptb"><CodeBlock language="bash">pnpm inject ptb</CodeBlock></TabItem>
</Tabs>
</Tabs>
8 changes: 4 additions & 4 deletions docs/users/getting-started/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ This is usually an issue with Discord moving around its installation location on
<details>
<summary>Installer won't open</summary>

If you are on Linux try rnning with the `--no-sandbox`
If you are on Linux try running with the `--no-sandbox`

If the installer does not seem to open, follow these steps:
1. Download and install [7-Zip](https://www.7-zip.org/)
1. Right click and extract the BetterDiscord installer into a folder.
1. Right-click and extract the BetterDiscord installer into a folder.
1. Run the exe found in the folder.

OR
Expand All @@ -68,7 +68,7 @@ Follow the [manual installation](../getting-started/installation/#manual-install
<summary>Installer is all black</summary>

Try one of the following:
- Right click the installer and select run as Administrator.
- Right-click the installer and select run as Administrator.
- Open the command prompt by pressing `win`+`r` type `cmd` and press enter. Then type `ipconfig /flushdns` and press enter in the window that appears.
- Disable your anti-virus temporarily.

Expand Down Expand Up @@ -110,4 +110,4 @@ Fully close Discord. Fully deactivate any VPNs or firewalls. Make sure your inst
<summary>❌ getaddrinfo ENOTFOUND api.github.com"</summary>

Disable your antivirus or swap your DNS servers. There is a good guide to do the latter found here: https://www.ionos.com/digitalguide/server/configuration/how-to-change-dns-server/
</details>
</details>
4 changes: 2 additions & 2 deletions docs/users/guides/installing-addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: How to extend BetterDiscord.

## Video

The second half of this video shows exaclty how to install addons.
The second half of this video shows exactly how to install addons.

<iframe width="850" height="478" src="https://www.youtube.com/embed/U0tTENsBS4w" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

Expand All @@ -20,4 +20,4 @@ The second half of this video shows exaclty how to install addons.
1. Drag and drop, or move, the plugin or theme you downloaded into this folder.
1. Go back to your `Plugins` or `Themes` pages and enable your plugin or theme.

![Addon Card](./img/addon_card.png)
![Addon Card](./img/addon_card.png)
12 changes: 6 additions & 6 deletions docs/users/guides/vanilla.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This feature requires some basic computer literacy.

:::

BetterDiscord allows you to return to vanilla Discord functionality without having to remove BetterDiscord. This is useful for those that like to switch back and forth. This is done using the `--vanilla` command line flag. There are two ways this can be used. You can either do this as a one-off, or setup a shortcut for yourself to easily boot between normal Discord and BetterDiscord.
BetterDiscord allows you to return to vanilla Discord functionality without having to remove BetterDiscord. This is useful for those that like to switch back and forth. This is done using the `--vanilla` command line flag. There are two ways this can be used. You can either do this as a one-off or setup a shortcut for yourself to easily boot between normal Discord and BetterDiscord.


## One-off
Expand All @@ -25,7 +25,7 @@ Running vanilla Discord as a one-off means next time you launch Discord, BetterD
<TabItem value="windows">

1. Ensure Discord is fully closed
1. Right click your existing Discord shortcut and select `Properties`
1. Right-click your existing Discord shortcut and select `Properties`
1. Copy the `Target` field
1. Open command prompt by pressing `⊞ win`+`r`
1. Paste the value of the `Target` field and add a space and `--vanilla` at the end
Expand Down Expand Up @@ -56,8 +56,8 @@ Creating a separate shortcut makes it easy to launch with either vanilla Discord
<TabItem value="windows">

1. Ensure Discord is fully closed
1. Right click your existing Discord shortcut and select `Create Shortcut`
1. Right click the new shortcut `Discord (2)` and select `Properties`
1. Right-click your existing Discord shortcut and select `Create Shortcut`
1. Right-click the new shortcut `Discord (2)` and select `Properties`
1. In the target field add a space followed by `--vanilla` at the end of the field
1. Click `OK`
1. Rename your new shortcut to something like `Discord Vanilla`
Expand All @@ -66,9 +66,9 @@ Creating a separate shortcut makes it easy to launch with either vanilla Discord
<TabItem value="mac">

1. Ensure Discord is fully closed
1. Open Automator app (`⌘ Command`+`Spacebar`)
1. Open the Automator app (`⌘ Command`+`Spacebar`)
1. Select `New Document` then `Application`
1. From the menu on the left drag `Run Shell Script` to the right hand side.
1. From the menu on the left drag `Run Shell Script` to the right-hand side.
1. On the right, in the textbox that appears, paste in `open -a '/Applications/Discord.app' --args --vanilla`
1. At the top, name your application something like `Discord Vanilla` and set `Where` to be the `Applications` folder
1. Go to `File > Save` to finalize
Expand Down
6 changes: 1 addition & 5 deletions docs/users/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,6 @@ BetterDiscord allows you to modify your Discord application and see the changes

BetterDiscord can make the Discord application partially see-through leading to very cool designs and desktop environments.

### Public Servers

BetterDiscord adds a public server directory sourced from [DiscordServers.com](https://discordservers.com/). This is different from the built-in discovery feature of Discord because DiscordServer is a community run listing and does not have the same requirements as discovery.

### Dual Boot

BetterDiscord allows you to have multiple shortcuts to Discord that allow you to quickly boot with or without BetterDiscord. No need to fiddle with installing and uninstalling.
Expand All @@ -45,7 +41,7 @@ Plugins can increase the functionality and user experience of the app through Ja

### Themes

Themes allow you to completely customize your client with CSS. You can either make your own theme, or download the wide variety of themes from our community.
Themes allow you to completely customize your client with CSS. You can either make your own theme or download the wide variety of themes from our community.

## Keep in Touch
- [Discord](https://betterdiscord.app/invite)
Expand Down

0 comments on commit 732f1c9

Please sign in to comment.