From f95e60e1b256643cc873d4b7ea9a2b0073367ba6 Mon Sep 17 00:00:00 2001 From: nitro <143457057+n7itro@users.noreply.github.com> Date: Mon, 23 Sep 2024 02:49:39 +0200 Subject: [PATCH] refactored desktop contribution docs - fixed typos, formatting - improved consistency and brevity --- content/building.md | 2 +- content/contribute/desktop.md | 80 +++++++++++++++-------------------- content/contribute/docs.md | 22 +++++----- 3 files changed, 47 insertions(+), 57 deletions(-) diff --git a/content/building.md b/content/building.md index d5fc1a1..db53eaf 100644 --- a/content/building.md +++ b/content/building.md @@ -3,7 +3,7 @@ title: Building Zen Browser 📦 lastmod: 2024-09-25 --- -We've took the time to make building Zen Browser as easy as possible, independent of your operating system or technical knowledge. +We've taken the time to make building Zen Browser as easy as possible, independent of your operating system or technical knowledge. > [!failure] > We cannot provide support if a build fails. Please understand this before proceeding with the following steps. diff --git a/content/contribute/desktop.md b/content/contribute/desktop.md index b13da60..4243554 100644 --- a/content/contribute/desktop.md +++ b/content/contribute/desktop.md @@ -14,64 +14,54 @@ Before you begin, ensure you have the following tools installed: - [**Node.js**](https://nodejs.org/): Required for building the browser. - [**npm**](https://www.npmjs.com/): Node package manager, which comes with Node.js. -![[building]] +## Making a Contribution -## Step 7: 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**: You can follow this GitHub official guide [Fork a repository - GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). +#### 1. Fork the Repository -2. **Create a New Branch**: It’s a good practice to create a new branch for each feature or bug fix. +#### 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. +```bash +git checkout -b feature/your-feature-name +``` -4. **Commit Your Changes**: Commit your changes with a descriptive message. +#### 3. Make Your Changes +Edit the code in your local repository. +- Ensure that your changes do not break existing functionality. +- Write tests if applicable. + +You can test your changes by +- [[live-editing | Editing the interface CSS in real-time]] +- [[building| Building the browser]] + +#### 4. Commit Your Changes +Commit your changes with a descriptive message. - ```bash - git commit -m "Add feature: your feature description" - ``` +```bash +git commit -m "Add feature: your feature description" +``` -5. **Push Your Changes**: Push your branch to your forked repository. +#### 5. Push Your Changes +Push your branch to your forked repository. - ```bash - git push origin feature/your-feature-name - ``` +```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. +#### 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. +- 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. +- [Zen Browser Repository](https://github.com/zen-browser/desktop) - [[CONTRIBUTING| Contribution Guidelines]] -- [[CODE_OF_CONDUCT | Code of Conduct]] - +- [[CODE_OF_CONDUCT | Code of Conduct]] +- [Searchfox](https://searchfox.org/) a source code indexing tool for Mozilla Firefox +- [MDN Web Docs](https://developer.mozilla.org/) a documentation repository and learning resource for web developers + --- Thank you for contributing to Zen Browser! Your contributions are valuable and help make the project better for everyone. \ No newline at end of file diff --git a/content/contribute/docs.md b/content/contribute/docs.md index 4f62477..12cb1f2 100644 --- a/content/contribute/docs.md +++ b/content/contribute/docs.md @@ -16,12 +16,12 @@ Before you begin, ensure you have the following tools installed: - [**npm**](https://www.npmjs.com/): Node package manager, which comes with Node.js. - [**Obsidian**](https://obsidian.md/): A powerful Markdown editor recommended for editing and organizing documentation. *(Optional)* -## Step 1: Fork the Repository +## 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 +## 2. Clone the Repository Once you have forked the repository, clone it to your local machine using the following command: @@ -32,7 +32,7 @@ cd docs Replace `` with your GitHub username. -## Step 3: Install Dependencies +## 3. Install Dependencies Navigate to the project directory and install the required dependencies: @@ -42,7 +42,7 @@ npm install This command installs all the necessary packages listed in the `package.json` file. -## Step 4: Open the Project in Obsidian +## 4. Open the Project in Obsidian Open the cloned repository folder in Obsidian to begin editing: @@ -50,13 +50,13 @@ Open the cloned repository folder in Obsidian to begin editing: 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 +## 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. +- **`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 @@ -65,7 +65,7 @@ You can now start editing the documentation. The project structure is as follows - Include examples and code snippets where applicable. - Ensure all links and references are accurate. -## Step 6: Preview the Documentation +## 6. Preview the Documentation To preview the documentation site locally, run the following command: @@ -75,7 +75,7 @@ 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 +## 7. Commit and Push Your Changes Once you are satisfied with your changes, commit them to your local repository: @@ -90,7 +90,7 @@ Push your changes to your forked repository: git push origin main ``` -## Step 8: Create a Pull Request +## 8. Create a Pull Request After pushing your changes, go to the original Zen Browser Documentation Repository and submit a pull request: