Skip to content

Commit

Permalink
📝 Fix typos in docs (#45)
Browse files Browse the repository at this point in the history
Co-authored-by: ggemre <gmoore1@byu.edu>
  • Loading branch information
ggemre and ggemre authored Dec 24, 2023
1 parent 17bde4d commit fbdee4a
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/content/getting-started/fileStructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ index 404a88b218c652afac0cb2004676d22da53d48f3..5a4668ef2970dd773536907f51f3e7e7
skin/classic/browser/monitor-border.png
```

In this patch, you can see that I am adding a `*` to the start of a line. You generate these patches by modifying the file in the `engine/` directory and running `gluon export` to export your changes to the src directory. Be careful, if you do not export your changes, they will not be saved and will not work on other developer's computers or yours after an update!
In this patch, you can see that I am adding a `*` to the start of a line. You generate these patches by modifying the file in the `engine/` directory and running `gluon export` to export your changes to the src directory. Be careful, if you do not export your changes, they will not be saved and will not work on other developers' computers or yours after an update!

```sh
gluon export browser/themes/linux/jar.mn
Expand Down
6 changes: 3 additions & 3 deletions docs/content/getting-started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This will ask you a variety of questions in relation to your project setup. Firs

You can change what version you are bound to at any time. Pulse Browser currently uses the stable releases, but if you want a lower workload, the newer Extended Support releases might be good for you.

Then next is the version of the browser you want to use. By default melon will populate this with the latest version available, which we recommend using. Simply click enter to accept.
Then next is the version of the browser you want to use. By default gluon will populate this with the latest version available, which we recommend using. Simply click enter to accept.

```
? Enter the version of this product › 102.0.1
Expand All @@ -74,7 +74,7 @@ Vendor is the company (or solo developer) who is creating the browser.
? Enter a vendor › Fushra
```

The appid follows reverse dns naming conventions. For example, Fushra owns the domain `fushra.com`, so our browser is `com.fushra.browser.desktop`. If you do not have a domain, you can use your username / psudomim as the appid, e.g. `trickypr.watermelon`.
The appid follows reverse dns naming conventions. For example, Fushra owns the domain `fushra.com`, so our browser is `com.fushra.browser.desktop`. If you do not have a domain, you can use your username / pseudonym as the appid, e.g. `trickypr.watermelon`.

```
? Enter an appid › dev.gluon.example
Expand All @@ -88,7 +88,7 @@ Next you need to chose a starting template for your browser. If you know what yo
❯ User Chrome (custom browser css, simplest)
```

Now you have created the directory structure for your project, you can build it for the first time. First, ask melon to download the firefox source.
Now you have created the directory structure for your project, you can build it for the first time. First, ask gluon to download the firefox source.

```sh
gluon download
Expand Down
4 changes: 2 additions & 2 deletions docs/content/guides/includingAddons.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Note that the `id` is the gecko application id specified in the `manifest.json`.

## Specifying location in customizable ui

By default, when an addon with a toolbar button, it will placed next to the hamburger menu. However, you may want to place it somewhere else. To do this, you must change the customizable ui in a similar way to how you would to remove pocket.
By default, when adding an addon with a toolbar button, it will be placed next to the hamburger menu. However, you may want to place it somewhere else. To do this, you must change the customizable ui in a similar way to how you would when removing pocket.

You are going to want to open `engine/browser/components/customizableui/CustomizableUI.jsm`. At the top, you want to import the `ExtensionCommon` module.

Expand All @@ -48,7 +48,7 @@ const { makeWidgetId } = ChromeUtils.import(
).ExtensionCommon
```

Then, at the top add a constant with the id of the addon at the top of the file, for example:
Then, add a constant with the id of the addon at the top of the file, for example:

```js
const kUBlockOriginID = 'uBlock0@raymondhill.net'
Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Building on windows is significantly more complex than building on macos or linu

## Installing Dependencies

The first thing you will need to do is install Microsoft's c++ build tools. You will need to download [Build Tools for Visual Studio 2022](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022). The following will need to be need installed:
The first thing you will need to do is install Microsoft's c++ build tools. You will need to download [Build Tools for Visual Studio 2022](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022). The following will need to be installed:

- **In the _Workloads_ tab**
- Desktop development with C++
Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight = 0

# gluon.json Reference

This reference guide may get out dated. If you need to check something, you can read [the config interface type](https://github.com/pulse-browser/gluon/blob/main/src/utils/config.ts#L96).
This reference guide may get outdated. If you need to check something, you can read [the config interface type](https://github.com/pulse-browser/gluon/blob/main/src/utils/config.ts#L96).

## name

Expand Down

0 comments on commit fbdee4a

Please sign in to comment.