Skip to content

docs: major wording, styling, formatting, and grammar enhancements #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions content/docs/contribute/desktop/building.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ We've taken the time to make building Zen Browser as easy as possible, independe
The following resources are essential for a successful build. Without them, you will encounter unnecessary build failures:

- Disk Space: Keep _30GB_ of free space on the disk (the build process is resource-intensive).
- Git ([Download here](https://git-scm.com/downloads)) – Required for version control and managing source code.
- Python 3 ([Download here](https://www.python.org/downloads/)) – Needed for running build scripts and automation tools.
- Node.js 21+ ([Download here](https://nodejs.org/)) – Required for managing dependencies and running JavaScript-based tools.
- sccache ([Download here](https://github.com/mozilla/sccache/releases)) – A caching tool that speeds up rebuilds by storing compiled objects.
- Git ([Download](https://git-scm.com/downloads)) – Required for version control and managing source code.
- Python 3 ([Download](https://www.python.org/downloads/)) – Required for running build scripts and automation tools.
- Node.js 21+ ([Download](https://nodejs.org/)) – Required for managing dependencies and running JavaScript-based tools.
- sccache ([Download](https://github.com/mozilla/sccache/releases)) – A caching tool that speeds up rebuilds by storing compiled objects.

<Callout>
If you're using Windows, ensure that all the basic software requirements are added to the `PATH` variable.
If you're using Windows, ensure that all the basic software requirements are added to `PATH`.
</Callout>

<Callout type="warn">
Expand Down Expand Up @@ -64,7 +64,7 @@ git clone https://github.com/zen-browser/desktop.git --depth 10
cd desktop
```

- **`--depth 10`**: This makes sure you dont download the entire git history, it would take a long time otherwise due to that we used to store compiled binaries on the repository.
- **`--depth 10`**: This ensures that your host doesn't download the entire Git history, which would take far too long, due to the fact that Zen used to store compiled binaries on the repository.

## Step 2: Install Dependencies

Expand Down Expand Up @@ -94,7 +94,7 @@ Before building the browser, it’s recommended to update the American English l
python3 ./scripts/update_en_US_packs.py
```

This script updates the "en-US" localization files, which are necessary for proper language support in Zen Browser. Running this step ensures that your build includes the latest translations and language resources.
This script updates the **en-US** localization files, which are necessary for proper language support in Zen Browser. Running this step ensures that your build includes the latest translations and language resources.

## Step 5: Build the Browser

Expand Down
14 changes: 7 additions & 7 deletions content/docs/contribute/desktop/code-structure-and-prefs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ description: Zen Browser Code Structure and Preference Management
The Zen Browser is a fork of Firefox with custom features like vertical tabs, workspaces, and themes. The source code is organized in the `src/` directory, with patches and custom implementations for Zen-specific features.

## Main Directories
- **src/zen/**: Contains Zen-specific features.
- `workspaces/`: Implements workspace functionality (e.g., ZenWorkspaces.mjs, ZenWorkspace.mjs).
- `src/zen/`: Contains Zen-specific features.
- `workspaces/`: Implements workspace functionality (e.g., `ZenWorkspaces.mjs`, `ZenWorkspace.mjs`).
- `compact-mode/`: Handles compact mode UI.
- `glance/`: Quick tab preview feature.
- `common/`: Shared utilities like ZenUIManager.mjs and ZenStartup.mjs.
- `common/`: Shared utilities like `ZenUIManager.mjs` and `ZenStartup.mjs`.
- `tabs/`: Tab management, including pinned tabs.
- **src/browser/**: Browser components with patches (e.g., browser.xhtml patches).
- **prefs/**: Preference files in YAML format for various features (e.g., zen.yaml for general prefs, glance.yaml for glance feature).
- `src/browser/`: Browser components with patches (e.g., `browser.xhtml` patches).
- `prefs/`: Preference files in YAML format for various features (e.g., `zen.yaml` for general prefs, `glance.yaml` for the Glance feature).

## How to Add New Preferences
Preferences in Zen Browser are defined in YAML files under `prefs/`. These are loaded and applied to customize behavior.
Expand All @@ -28,12 +28,12 @@ Preferences in Zen Browser are defined in YAML files under `prefs/`. These are l
```

2. **Define the Pref**:
- `name`: The preference key (e.g., 'zen.workspaces.enable-feature').
- `name`: The preference key (e.g., `zen.workspaces.enable-feature`).
- `value`: Default value (bool, string, int).
- *`condition`: Optional*

3. **Integrate in Code**:
- Use `Services.prefs.getBoolPref('zen.workspaces.new-pref', defaultValue)` in JavaScript files (e.g., ZenWorkspaces.mjs).
- Use `Services.prefs.getBoolPref('zen.workspaces.new-pref', defaultValue)` in JavaScript files (e.g., `ZenWorkspaces.mjs`).

4. **Build and Test**:
- Rebuild the browser.
Expand Down
9 changes: 6 additions & 3 deletions content/docs/contribute/docs/editing-with-vscode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,12 @@ Visual Studio Code (VS Code) is a popular and powerful code editor that works we
## Prerequisites

- [**Visual Studio Code**](https://code.visualstudio.com/) installed on your machine.
- *Note: Popular forks of VS Code, such as [VSCodium](https://vscodium.com/), should also work well.*

## Recommended Extension: MDX
<Callout type="info">
Popular forks of VS Code, such as [VSCodium](https://vscodium.com/), should also work well.
</Callout>

## MDX Extension

To get the best experience editing `.mdx` files in VS Code, we recommend installing the official MDX extension.

Expand Down Expand Up @@ -47,7 +50,7 @@ To get the best experience editing `.mdx` files in VS Code, we recommend install
- Syntax highlighting for Markdown and JSX
- IntelliSense suggestions
- Error checking
<Callout type="warn" title="Image Paths">
<Callout type="warn" title="Referencing images in your code">
When adding images, reference them from `/assets` (not `/public/assets`). Example:
```
![Example Image](/assets/user-manual/image.png)
Expand Down
22 changes: 12 additions & 10 deletions content/docs/contribute/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,23 +34,25 @@ Please follow the appropriate guide based on the repository you want to contribu

### Reporting Bugs

If you find a bug, please open an issue and describe the problem in detail. Include steps to reproduce the bug, the expected behavior, and any relevant information about your environment. Please verify that the bug has not been reported already.
If you find a bug, please open an issue on the correct repository's GitHub and describe the problem in detail. Include steps to reproduce the bug, the expected behavior, and any relevant information about your environment. Please verify that the bug has not been reported already.

<Callout type="info">
Open the issue in it's corresponding GitHub repository:
<Callout type="info" title="Click here to open each repository's GitHub Issues page">

- [Desktop Browser App](https://github.com/zen-browser/desktop/issues)
- [Zen's Custom Mods](https://github.com/zen-browser/theme-store)
- [Zen's Homepage Website](https://github.com/zen-browser/www)
- [This documentation Website](https://github.com/zen-browser/docs)
- [Zen Browser for Windows, Linux, and macOS (Main Repository)](https://github.com/zen-browser/desktop/issues)
- [Zen Browser Mods/Theme Store](https://github.com/zen-browser/theme-store/issues)
- [Zen Browser Website](https://github.com/zen-browser/www/issues)
- [Zen Browser Documentation](https://github.com/zen-browser/docs/issues)
</Callout>

### Suggesting Features

![Discuss](/assets/contribute/discuss.png)
![GitHub Discussions](/assets/contribute/discuss.png)

We welcome suggestions for new features or improvements to existing ones. To suggest a feature, please start a new Github discussion in the Ideas category.
_Use the correct Github Repository based on the list above_
We welcome suggestions for new features or improvements. Have an idea to make Zen better? Create a [new GitHub Discussion in the main browser repository](https://github.com/zen-browser/desktop/discussions), and label it under the Ideas category.
<Callout type="info" title="Alternatively, join the Zen Discord and discuss there!">

- [https://discord.gg/zen-browser](https://discord.gg/zen-browser)
</Callout>

---

Expand Down
6 changes: 3 additions & 3 deletions content/docs/contribute/www.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ This command will start a local server and open the homepage in your default web

You can now start making changes to the homepage. The project structure is as follows:

- **src/**: Contains the source code for the homepage.
- **public/**: Contains static files like images and HTML templates.
- **package.json**: Lists the project's dependencies and scripts.
- `src/`: Contains the source code for the homepage.
- `public/`: Contains static files like images and HTML templates.
- `package.json`: Lists the project's dependencies and scripts.

Feel free to explore and modify the files to implement new features or fix bugs.

Expand Down
Loading