ZenBrowserMirrors/docs
1
0
Fork 0
mirror of https://github.com/zen-browser/docs.git synced 2025-07-07 17:05:34 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore: Create the 'Zen Browser Contribution Guides' section (CURRENTLY IN DRAFT)

Browse source
This commit is contained in:
Jafeth Garro 2024-08-23 20:53:40 -06:00
parent 8d11984942
commit b232772a34
10 changed files with 542 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

8
content/.obsidian/types.json vendored Normal file
View file

@ -0,0 +1,8 @@
{
"types": {
"aliases": "aliases",
"cssclasses": "multitext",
"tags": "tags",
"draft": "checkbox"
}
}

28
content/.obsidian/workspace.json vendored
View file

@ -25,7 +25,7 @@
"state": {
"type": "markdown",
"state": {
"file": "building-zen-browser/building-zen-browser.md",
"file": "contribute/index.md",
"mode": "preview",
"source": true
}
@ -98,7 +98,7 @@
"state": {
"type": "backlink",
"state": {
"file": "building-zen-browser/building-zen-browser.md",
"file": "contribute/index.md",
"collapseAll": false,
"extraContext": false,
"sortOrder": "alphabetical",
@ -115,7 +115,7 @@
"state": {
"type": "outgoing-link",
"state": {
"file": "building-zen-browser/building-zen-browser.md",
"file": "contribute/index.md",
"linksCollapsed": false,
"unlinkedCollapsed": true
}
@ -138,7 +138,7 @@
"state": {
"type": "outline",
"state": {
"file": "building-zen-browser/building-zen-browser.md"
"file": "contribute/index.md"
}
}
}
@ -161,11 +161,26 @@
},
"active": "42952bec6b18e374",
"lastOpenFiles": [
"contribute/CODE_OF_CONDUCT.md",
"contribute/CONTRIBUTING.md",
"contribute/desktop.md",
"contribute/docs.md",
"contribute/index.md",
"contribute/translation.md",
"contribute/www.md",
"building-zen-browser/index.md",
"building-zen-browser/building-zen-browser.md",
"themes-store/themes-marketplace-submission-guidelines.md",
"themes-store/themes-marketplace.md",
"themes-store/themes-marketplace-preferences.md",
"index.md",
"guides/generic-optimized.md",
"guides/Untitled.md",
"contribute",
"themes-store/Untitled",
"guides/live-editing.md",
"guides/manage-profiles.md",
"guides/install-macos.md",
"themes-store/themes-marketplace-submission-guidelines.md",
"themes-store/themes-marketplace.md",
"assets/live-editing",
"assets/live-editing/inspect.png",
"assets/image (3).png",
@ -173,7 +188,6 @@
"faq.md",
"assets/macos-installation-guide/gatekeeper.png",
"assets/macos-installation-guide/open-dmg.png",
"index.md",
"assets/macos-installation-guide/broken-menu.png",
"assets/macos-installation-guide/Screenshot from 2024-08-20 22-41-07.png",
"assets/macos-installation-guide/broken menu.png",

42
content/building-zen-browser/building-zen-browser.md
View file

@ -2,41 +2,59 @@
title: Building Zen Browser
---
> [!failure]
> We cannot provide support if a build fails. Please understand this before proceeding with the following steps.
We've took the time to make building Zen Browser as easy as possible, independent of your operating system or technical knowledge.
1. Clone the repository
## Step 1: Clone the Project
First, you need to clone the Zen Browser repository to your local machine. This will create a local copy of the project that you can work on.
```bash
git clone https://github.com/zen-browser/desktop.git --recurse-submodules
cd desktop
```
2. Install dependencies
- **`--recurse-submodules`**: This flag ensures that all submodules are cloned along with the main project. Zen Browser relies on several submodules, so this step is essential.
## Step 2: Install Dependencies
Once you have cloned the project, navigate to the project directory and install the necessary dependencies using npm:
```bash
npm install
npm i
```
3. Download and bootstrap the browser
This command will install all the packages listed in the `package.json` file, which are required for building and running Zen Browser.
## Step 3: Download and Bootstrap the Browser
To set up the browser, you need to download additional files and prepare the environment:
```bash
npm run init
```
4. Start building the browser
This command handles all the necessary bootstrapping tasks, such as setting up configuration files and downloading essential resources.
> [!info]
> This may take a while, depending on your internet connection and computer speed.
## Step 4: Build the Browser
Now that everything is set up, you can build the browser:
```bash
npm run build
```
5. Start the browser!
This command compiles the source code and creates the necessary files for running Zen Browser.
## Step 5: Run the Browser
After building the browser, you can start it using:
```bash
npm start
```
```
This command launches the browser, allowing you to see your changes in action.
> [!failure]
> We cannot provide support if a build fails. Please understand this before proceeding with the following steps.

72
content/contribute/CODE_OF_CONDUCT.md Normal file
View file

@ -0,0 +1,72 @@
---
title: Code of Conduct
---
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others’ private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and it also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [insert contact method]. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of actions.
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
[homepage]: https://www.contributor-covenant.org

57
content/contribute/CONTRIBUTING.md Normal file
View file

@ -0,0 +1,57 @@
---
title: Contributing to Zen Browser
---
Thank you for considering contributing to Zen Browser! We appreciate your time and effort in improving this project. The following is a set of guidelines for contributing to Zen Browser. These guidelines are intended to make it easier for you to get involved.
## How to Contribute
### 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.
>[!important]
>Open the issue in it's corresponding GitHub repository:
>- [Desktop Browser App](https://github.com/zen-browser/desktop/issues)
>- [Zen's Custom Themes](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)
### Suggesting Features
We welcome suggestions for new features or improvements to existing ones. To suggest a feature, please open an issue and use the "Feature Request" template to describe your idea.
*Use the correct Github Repository based on the list above*
## Types of Contributions
We welcome a wide range of contributions, including but not limited to:
- **Bug Fixes**: Resolve existing issues in the code.
- **New Features**: Implement new features or enhance existing ones.
- **Documentation**: Improve the clarity and depth of documentation.
- **Code Refactoring**: Clean up the code to improve readability, performance, or maintainability.
- **UI/UX Enhancements**: Improve the user interface or user experience of Zen Browser.
## Getting Started
To help you get started with contributing, we have created separate guides for each repository:
- [[desktop | Getting Started with Desktop Browser Development]]
- [[www | Getting Started with Zen's Homepage Development]]
- [[docs | Getting Started with Documentation Contributions]]
- [[translation | Getting Started with Translations]]
Please follow the appropriate guide based on the repository you want to contribute to.
## Code of Conduct
Please note that this project is governed by a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
## License
By contributing to Zen Browser, you agree that your contributions will be licensed under the [MPL-2.0 License](https://github.com/zen-browser/desktop/blob/main/LICENSE).
---
Thank you for your interest in contributing to Zen Browser! We look forward to your contributions.

75
content/contribute/desktop.md Normal file
View file

@ -0,0 +1,75 @@
---
title: Getting Started with Desktop Browser Development
---
Contributing to the Zen Browser Desktop project is a great way to get involved with open-source software development. This guide will walk you through the steps to clone the project, set up your development environment, make contributions, and submit pull requests.
## Prerequisites
Before you begin, ensure you have the following tools installed:
- **Git**: Version control system to clone the repository and manage your code.
- **Node.js**: Required for building the browser.
- **npm**: Node package manager, which comes with Node.js.
![[building-zen-browser]]
## Step 6: Making a Contribution
### Types of Contributions
You can contribute to Zen Browser in various ways, including:
- **Bug Fixes**: Identify and fix bugs in the codebase.
- **Feature Development**: Implement new features or enhance existing ones.
- **Documentation**: Improve or expand the project's documentation.
- **Code Optimization**: Refactor the code for better performance or readability.
- **UI/UX Improvements**: Enhance the user interface or user experience.
### Guidelines for Contributions
Before contributing, please keep the following guidelines in mind:
- **Follow the [[CODE_OF_CONDUCT | Code of Conduct]]**: Be respectful and constructive in your interactions.
- **Stick to the Coding Standards**: Ensure your code adheres to the project's coding conventions. This includes proper indentation, comments, and naming conventions.
- **Write Clear Commit Messages**: Your commit messages should be descriptive and concise.
- **Test Your Changes**: Ensure that your code changes do not break existing functionality. Write tests if applicable.
### How to Make a Pull Request
1. **Fork the Repository**: Create a fork of the Zen Browser repository on GitHub.
2. **Create a New Branch**: It’s a good practice to create a new branch for each feature or bug fix.
```bash
git checkout -b feature/your-feature-name
```
3. **Make Your Changes**: Edit the code in your local repository.
4. **Commit Your Changes**: Commit your changes with a descriptive message.
```bash
git commit -m "Add feature: your feature description"
```
5. **Push Your Changes**: Push your branch to your forked repository.
```bash
git push origin feature/your-feature-name
```
6. **Submit a Pull Request**: Go to the original Zen Browser repository and submit a pull request from your forked repository.
- Provide a clear title and description of your changes.
- Reference any relevant issues in the pull request.
## Additional Resources
- [Zen Browser GitHub Repository](https://github.com/zen-browser/desktop): The main repository where you can find the source code and submit pull requests.
- [[desktop | Contribution Guidelines]]
- [[CODE_OF_CONDUCT | Code of Conduct]]
---
Thank you for contributing to Zen Browser! Your contributions are valuable and help make the project better for everyone.

112
content/contribute/docs.md Normal file
View file

@ -0,0 +1,112 @@
---
title: Getting Started with Documentation Contributions
---
This guide will help you get started with contributing to the documentation for Zen Browser. The documentation is crucial for helping users and developers understand and use the project effectively. We use Quartz v4 for generating the static documentation site, and we recommend using Obsidian as your Markdown editor for making contributions.
## Prerequisites
Before you begin, ensure you have the following tools installed:
- **Git**: Version control system to clone the repository and manage your code.
- **Node.js**: Required for building the Quartz v4 site.
- **npm**: Node package manager, which comes with Node.js.
- **Obsidian**: A powerful Markdown editor recommended for editing and organizing documentation. *(Optional)*
## Step 1: Fork the Repository
1. Navigate to the [Zen Browser Documentation Repository](https://github.com/zen-browser/docs).
2. Click on the "Fork" button at the top right of the repository page to create a personal copy of the repository under your GitHub account.
## Step 2: Clone the Repository
Once you have forked the repository, clone it to your local machine using the following command:
```bash
git clone https://github.com/<your-username>/docs.git
cd docs
```
Replace `<your-username>` with your GitHub username.
## Step 3: Install Dependencies
Navigate to the project directory and install the required dependencies:
```bash
npm install
```
This command installs all the necessary packages listed in the `package.json` file.
## Step 4: Open the Project in Obsidian
Open the cloned repository folder in Obsidian to begin editing:
1. Open Obsidian.
2. Click on "Open folder as vault" and select the folder containing the cloned repository.
3. You can now browse, edit, and add new Markdown files to the project.
## Step 5: Make Your Changes
You can now start editing the documentation. The project structure is as follows:
- **content/**: Contains the Markdown files for the documentation.
- **assets/**: Contains images and other static assets used in the documentation.
- **data/**: Contains any additional data files needed for the documentation.
### Writing Guidelines
- Follow the existing structure and formatting conventions.
- Use clear and concise language.
- Include examples and code snippets where applicable.
- Ensure all links and references are accurate.
## Step 6: Preview the Documentation
To preview the documentation site locally, run the following command:
```bash
npx quartz build --serve
```
This command starts a local server and opens the documentation site in your default web browser. The site will automatically reload whenever you make changes to the Markdown files.
## Step 7: Commit and Push Your Changes
Once you are satisfied with your changes, commit them to your local repository:
```bash
git add .
git commit -m "Description of your changes"
```
Push your changes to your forked repository:
```bash
git push origin main
```
## Step 8: Create a Pull Request
After pushing your changes, go to the original Zen Browser Documentation Repository and submit a pull request:
1. Navigate to the repository you forked from.
2. Click on the "Pull Requests" tab.
3. Click on "New Pull Request" and select your branch.
4. Provide a clear and concise description of your changes.
5. Submit the pull request.
Your pull request will be reviewed by the maintainers, and you may be asked to make some adjustments. Once approved, your changes will be merged into the main branch.
## Additional Resources
- [Zen Browser Documentation Repository](https://github.com/zen-browser/docs)
- [Quartz v4 Documentation](https://quartz.jzhao.xyz/)
- [[desktop | Contribution Guidelines]]
- [[CODE_OF_CONDUCT | Code of Conduct]]
---
Thank you for contributing to Zen Browser's documentation! Your contributions help users and developers understand and effectively use the project.

4
content/contribute/index.md Normal file
View file

@ -0,0 +1,4 @@
---
title: Zen Browser Contribution Guides 🌟
draft: true
---

61
content/contribute/translation.md Normal file
View file

@ -0,0 +1,61 @@
---
title: Getting Started with Translations
---
Thank you for your interest in contributing to the translations for Zen Browser! Ensuring that Zen Browser is accessible to users around the world is a key priority, and your contributions help make this possible. This guide will walk you through the process of getting started with translating Zen Browser using Crowdin.
## Prerequisites
Before you begin, you will need to have the following:
- **A Crowdin Account**: You can sign up for free at [Crowdin](https://crowdin.com).
- **Basic Knowledge of the Language**: A good understanding of the language you are translating to is essential.
## Step 1: Join the Zen Browser Translation Project
1. Visit the [Zen Browser Translation Project on Crowdin](https://crowdin.com/project/zen-browser).
2. Click on the "Join" button to become a contributor to the project.
3. Select the language you want to contribute to from the list of available languages.
## Step 2: Start Translating
Once you have joined the project and selected your language, you can start translating:
1. Navigate to the language you selected.
2. You will see a list of files that need translation. Click on any file to start translating.
3. Translate the strings from English to your selected language. Ensure that the translations are accurate and clear.
4. Save your translations as you work.
## Step 3: Review and Suggest Improvements
In addition to translating, you can also review translations made by others:
1. Go to your selected language.
2. Review the translations and suggest improvements if necessary.
3. Approve translations that are correct and meet the quality standards.
## Step 4: Communicate with Other Translators
Crowdin provides communication tools to collaborate with other translators:
- **Comments**: Leave comments on specific strings if you have questions or suggestions.
- **Discussions**: Participate in project-wide discussions to coordinate with other translators.
## Step 5: Stay Updated
Crowdin allows you to track the progress of the translation project and stay updated on new strings that need translation:
- **Notifications**: Enable notifications in your Crowdin account to be alerted when new content is available for translation.
- **Progress Tracking**: Use the progress bars to see how much of the translation is complete for your selected language.
## Additional Resources
- [Zen Browser Translation Project on Crowdin](https://crowdin.com/project/zen-browser)
- [Crowdin Documentation](https://support.crowdin.com/)
- [[desktop | Contribution Guidelines]]
- [[CODE_OF_CONDUCT | Code of Conduct]]
---
Thank you for helping to make Zen Browser accessible to a global audience! Your contributions are invaluable.

102
content/contribute/www.md Normal file
View file

@ -0,0 +1,102 @@
---
title: Getting Started with Zen's Homepage Development
---
This guide will walk you through the steps required to set up and contribute to the development of Zen Browser's homepage. Whether you're fixing bugs, adding new features, or enhancing the design, this guide will help you get started.
## Prerequisites
Before you begin, make sure you have the following installed on your machine:
- **Git**: Version control system to clone the repository and manage your code.
- **Node.js**: JavaScript runtime for running the development server and building the project.
- **npm**: Node package manager, which comes with Node.js.
## Step 1: Fork the Repository
1. Navigate to the [Zen Browser Homepage Repository](https://github.com/zen-browser/www).
2. Click on the "Fork" button at the top right of the repository page. This creates a personal copy of the repository under your GitHub account.
## Step 2: Clone the Repository
Once you have forked the repository, clone it to your local machine using the following command:
```bash
git clone https://github.com/<your-username>/www.git
cd www
```
Replace `<your-username>` with your GitHub username.
## Step 3: Install Dependencies
Navigate to the project directory and install the required dependencies:
```bash
npm install
```
This command installs all the necessary packages listed in the `package.json` file.
## Step 4: Start the Development Server
After installing the dependencies, you can start the development server:
```bash
npm start
```
This command will start a local server and open the homepage in your default web browser. The server will automatically reload whenever you make changes to the code.
## Step 5: Make Your Changes
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.
Feel free to explore and modify the files to implement new features or fix bugs.
## Step 6: Test Your Changes
Before submitting your changes, make sure they work as expected. Check the functionality across different pages and ensure that your changes do not introduce any new issues.
## Step 7: Commit and Push Your Changes
Once you are satisfied with your changes, commit them to your local repository:
```bash
git add .
git commit -m "Description of your changes"
```
Push your changes to your forked repository:
```bash
git push origin main
```
## Step 8: Create a Pull Request
After pushing your changes, go to the original Zen Browser Homepage Repository and submit a pull request:
1. Navigate to the repository you forked from.
2. Click on the "Pull Requests" tab.
3. Click on "New Pull Request" and select your branch.
4. Provide a clear and concise description of your changes.
5. Submit the pull request.
Your pull request will be reviewed by the maintainers, and you may be asked to make some adjustments. Once approved, your changes will be merged into the main branch.
## Additional Resources
- [Zen Browser Homepage Repository](https://github.com/zen-browser/www)
- [[desktop | Contribution Guidelines]]
- [[CODE_OF_CONDUCT | Code of Conduct]]
---
Thank you for contributing to Zen Browser's homepage! Your contributions help make the project better for everyone.