From 122711d0870e9c7665840459ed9db05f190d4622 Mon Sep 17 00:00:00 2001 From: Ekemini Date: Tue, 27 Feb 2024 21:26:23 +0100 Subject: [PATCH 01/11] Add documentation contribution guide --- CONTRIBUTING.md | 9 +++ docs/home/docs-contribution-guide.mdx | 82 +++++++++++++++++++++++++++ local-server-guide | 0 src/theme/Home.jsx | 4 +- 4 files changed, 93 insertions(+), 2 deletions(-) create mode 100644 docs/home/docs-contribution-guide.mdx create mode 100644 local-server-guide diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bca2e7e42..580f0f68c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,8 @@ our way or a bug to report: repo](https://github.com/helium/docs). Include a write up of the PR with details on what it does. +* To contribute to the documentation by setting up a server locally, visit [Contribution Guide: Setting Up Local Server for Documentation][local-server-guide]. + * **Reporting Bugs**: Open an issue [against this repo](https://github.com/helium/docs/issues) with as much detail as you can. At the very least you'll include steps to @@ -36,3 +38,10 @@ collaboration, and contributors are expected to adhere to the Conduct](http://contributor-covenant.org/). Above all, thank you for taking the time to be a part of the Helium Community. + + + + + + +[local-server-guide]: docs/home/docs-contribution-guide.mdx diff --git a/docs/home/docs-contribution-guide.mdx b/docs/home/docs-contribution-guide.mdx new file mode 100644 index 000000000..2faff2c35 --- /dev/null +++ b/docs/home/docs-contribution-guide.mdx @@ -0,0 +1,82 @@ +--- +id: docs-contribution-guide +title: documentation contribution guide +description: How to install helium docs locally +slug: /home/docs-contribution-guide +--- + +### Installation Guide: Running the Server Locally + +#### Prerequisites: +- Node.js installed on your machine. You can download it from [the official Node.js website](https://nodejs.org/). +- Yarn package manager installed. You can install it by following the instructions below: + +#### Steps (Assuming you have Node.js Installed): +1. **Install Yarn:** + - Download and install Yarn by following the instructions on the [Yarn website](https://classic.yarnpkg.com/lang/en/docs/install/). + - You can also install Yarn globally using npm: + ``` + npm install -g yarn + ``` + - After installing, you can verify the installation by running: + ``` + yarn --version + ``` + - This should display the installed Yarn version. + +2. **Fork the Project Repository:** + - Fork the project repository to your GitHub account by clicking the "Fork" button at the top right of the repository page. + + +3. **Clone the Project Repository:** + - Clone the project repository to your local machine using Git: + ``` + git clone https://github.com/your-username/project-repository-name.git + ``` + - Change into the project's `docs/` folder: + ``` + cd project-repository/docs + ``` + +4. **Install Dependencies:** + - Inside the `docs/` folder, install project dependencies and start the server using: + ``` + yarn && yarn start + ``` + - This command should install project dependencies and start the server, automatically opening the project's documentation in your default web browser. + +5. **Access the Documentation:** + - The local server should now be running, and you can view the documentation by navigating to: + ``` + http://localhost:3000/ + ``` + - This will open the documentation website locally, allowing you to browse and interact with the project's documentation. + + + #### Start Contributing: +- After running the server, you can open the project in your preferred code editor, such as Visual Studio Code. +- Make changes to the documentation files, and as you save them, you will see the updates reflected in the browser window opened by the local server. + + + +### Example Commands: +```bash +# Clone the repository +git clone https://github.com/your-username/project-repository.git +cd project-repository/docs + +# Install Yarn (if not already installed) +npm install -g yarn + +# Install project dependencies +yarn + +# Start the local server +yarn start +``` + +#### Notes: +- Make sure to replace `your-username/project-repository` with the actual URL of the project repository. +- These instructions assume you are running these commands in a terminal or command prompt. +- The local server typically runs on `http://localhost:3000/`, but it might vary depending on the project configuration. + diff --git a/local-server-guide b/local-server-guide new file mode 100644 index 000000000..e69de29bb diff --git a/src/theme/Home.jsx b/src/theme/Home.jsx index ef1c4ae6b..e06ca4234 100644 --- a/src/theme/Home.jsx +++ b/src/theme/Home.jsx @@ -14,8 +14,8 @@ export const Home = () => ( with Helium

- Build amazing connected solutions on the world's largest decentralized wireless - network. + The world's largest decentralized wireless + network!

From ec1de051ce5314cf066c0e6d3507cd1eb1eb68fd Mon Sep 17 00:00:00 2001 From: Ekemini Date: Tue, 27 Feb 2024 21:35:29 +0100 Subject: [PATCH 02/11] Update File extension to .md --- CONTRIBUTING.md | 2 +- .../{docs-contribution-guide.mdx => docs-contribution-guide.md} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/home/{docs-contribution-guide.mdx => docs-contribution-guide.md} (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 580f0f68c..732b7e293 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,4 +44,4 @@ Above all, thank you for taking the time to be a part of the Helium Community. -[local-server-guide]: docs/home/docs-contribution-guide.mdx +[local-server-guide]: docs/home/docs-contribution-guide.md diff --git a/docs/home/docs-contribution-guide.mdx b/docs/home/docs-contribution-guide.md similarity index 100% rename from docs/home/docs-contribution-guide.mdx rename to docs/home/docs-contribution-guide.md From 5927f60995f8f4ae871f4b2323a38af82251bde9 Mon Sep 17 00:00:00 2001 From: Ekemini Date: Tue, 27 Feb 2024 21:42:04 +0100 Subject: [PATCH 03/11] Remove front matter from .md file --- docs/home/docs-contribution-guide.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/home/docs-contribution-guide.md b/docs/home/docs-contribution-guide.md index 2faff2c35..d3fcf2d1c 100644 --- a/docs/home/docs-contribution-guide.md +++ b/docs/home/docs-contribution-guide.md @@ -1,9 +1,4 @@ ---- -id: docs-contribution-guide -title: documentation contribution guide -description: How to install helium docs locally -slug: /home/docs-contribution-guide ---- + ### Installation Guide: Running the Server Locally From 0b14a3295ed8e274822349a64d349d842facf575 Mon Sep 17 00:00:00 2001 From: Ekemini Date: Tue, 27 Feb 2024 21:45:14 +0100 Subject: [PATCH 04/11] Increase size of heading --- docs/home/docs-contribution-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/docs-contribution-guide.md b/docs/home/docs-contribution-guide.md index d3fcf2d1c..ebdb43f3b 100644 --- a/docs/home/docs-contribution-guide.md +++ b/docs/home/docs-contribution-guide.md @@ -1,6 +1,6 @@ -### Installation Guide: Running the Server Locally +## Installation Guide: Running the Server Locally #### Prerequisites: - Node.js installed on your machine. You can download it from [the official Node.js website](https://nodejs.org/). From 3cd6b0ac5996ed2dbe02337c14bed7e970323eed Mon Sep 17 00:00:00 2001 From: Ekemini Date: Tue, 27 Feb 2024 21:46:14 +0100 Subject: [PATCH 05/11] Increase size of heading --- docs/home/docs-contribution-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/docs-contribution-guide.md b/docs/home/docs-contribution-guide.md index ebdb43f3b..5288fcd2d 100644 --- a/docs/home/docs-contribution-guide.md +++ b/docs/home/docs-contribution-guide.md @@ -1,6 +1,6 @@ -## Installation Guide: Running the Server Locally +# Installation Guide: Running the Server Locally #### Prerequisites: - Node.js installed on your machine. You can download it from [the official Node.js website](https://nodejs.org/). From 0e7f87a2e87f0c7782717b4bfbab249bd3b7bf36 Mon Sep 17 00:00:00 2001 From: Ekemini Date: Tue, 27 Feb 2024 21:50:02 +0100 Subject: [PATCH 06/11] Add prettier format according to project style guide --- docs/home/docs-contribution-guide.md | 41 ++++++++++++++++++---------- 1 file changed, 26 insertions(+), 15 deletions(-) diff --git a/docs/home/docs-contribution-guide.md b/docs/home/docs-contribution-guide.md index 5288fcd2d..25553f972 100644 --- a/docs/home/docs-contribution-guide.md +++ b/docs/home/docs-contribution-guide.md @@ -1,14 +1,17 @@ - - # Installation Guide: Running the Server Locally #### Prerequisites: -- Node.js installed on your machine. You can download it from [the official Node.js website](https://nodejs.org/). + +- Node.js installed on your machine. You can download it from + [the official Node.js website](https://nodejs.org/). - Yarn package manager installed. You can install it by following the instructions below: #### Steps (Assuming you have Node.js Installed): + 1. **Install Yarn:** - - Download and install Yarn by following the instructions on the [Yarn website](https://classic.yarnpkg.com/lang/en/docs/install/). + + - Download and install Yarn by following the instructions on the + [Yarn website](https://classic.yarnpkg.com/lang/en/docs/install/). - You can also install Yarn globally using npm: ``` npm install -g yarn @@ -20,10 +23,12 @@ - This should display the installed Yarn version. 2. **Fork the Project Repository:** - - Fork the project repository to your GitHub account by clicking the "Fork" button at the top right of the repository page. + - Fork the project repository to your GitHub account by clicking the "Fork" button at the top + right of the repository page. 3. **Clone the Project Repository:** + - Clone the project repository to your local machine using Git: ``` git clone https://github.com/your-username/project-repository-name.git @@ -34,27 +39,31 @@ ``` 4. **Install Dependencies:** + - Inside the `docs/` folder, install project dependencies and start the server using: ``` yarn && yarn start ``` - - This command should install project dependencies and start the server, automatically opening the project's documentation in your default web browser. + - This command should install project dependencies and start the server, automatically opening + the project's documentation in your default web browser. 5. **Access the Documentation:** - The local server should now be running, and you can view the documentation by navigating to: ``` http://localhost:3000/ ``` - - This will open the documentation website locally, allowing you to browse and interact with the project's documentation. - - - #### Start Contributing: -- After running the server, you can open the project in your preferred code editor, such as Visual Studio Code. -- Make changes to the documentation files, and as you save them, you will see the updates reflected in the browser window opened by the local server. + - This will open the documentation website locally, allowing you to browse and interact with the + project's documentation. +#### Start Contributing: +- After running the server, you can open the project in your preferred code editor, such as Visual + Studio Code. +- Make changes to the documentation files, and as you save them, you will see the updates reflected + in the browser window opened by the local server. ### Example Commands: + ```bash # Clone the repository git clone https://github.com/your-username/project-repository.git @@ -71,7 +80,9 @@ yarn start ``` #### Notes: -- Make sure to replace `your-username/project-repository` with the actual URL of the project repository. -- These instructions assume you are running these commands in a terminal or command prompt. -- The local server typically runs on `http://localhost:3000/`, but it might vary depending on the project configuration. +- Make sure to replace `your-username/project-repository` with the actual URL of the project + repository. +- These instructions assume you are running these commands in a terminal or command prompt. +- The local server typically runs on `http://localhost:3000/`, but it might vary depending on the + project configuration. From d5e7e0ac66d4f597313b8390468d758014c7fadc Mon Sep 17 00:00:00 2001 From: Ekemini Date: Tue, 27 Feb 2024 22:07:43 +0100 Subject: [PATCH 07/11] Update sentence to original --- src/theme/Home.jsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/theme/Home.jsx b/src/theme/Home.jsx index e06ca4234..ef1c4ae6b 100644 --- a/src/theme/Home.jsx +++ b/src/theme/Home.jsx @@ -14,8 +14,8 @@ export const Home = () => ( with Helium

- The world's largest decentralized wireless - network! + Build amazing connected solutions on the world's largest decentralized wireless + network.

From ee3f3771aca462c034a9a6a89f9dd7c48ae6edee Mon Sep 17 00:00:00 2001 From: Ekemini Date: Thu, 29 Feb 2024 07:45:51 +0100 Subject: [PATCH 08/11] Update docs with reviewed changes and instructions --- CONTRIBUTING.md | 5 +- docs/home/docs-contribution-guide.md | 88 -------------- docs/home/faq/docs-installation.mdx | 173 ++++++++++----------------- local-server-guide | 0 4 files changed, 61 insertions(+), 205 deletions(-) delete mode 100644 docs/home/docs-contribution-guide.md delete mode 100644 local-server-guide diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 732b7e293..a7f3e4f98 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,7 +41,4 @@ Above all, thank you for taking the time to be a part of the Helium Community. - - - -[local-server-guide]: docs/home/docs-contribution-guide.md +[local-server-guide]: docs/home/faq/docs-installation.mdx diff --git a/docs/home/docs-contribution-guide.md b/docs/home/docs-contribution-guide.md deleted file mode 100644 index 25553f972..000000000 --- a/docs/home/docs-contribution-guide.md +++ /dev/null @@ -1,88 +0,0 @@ -# Installation Guide: Running the Server Locally - -#### Prerequisites: - -- Node.js installed on your machine. You can download it from - [the official Node.js website](https://nodejs.org/). -- Yarn package manager installed. You can install it by following the instructions below: - -#### Steps (Assuming you have Node.js Installed): - -1. **Install Yarn:** - - - Download and install Yarn by following the instructions on the - [Yarn website](https://classic.yarnpkg.com/lang/en/docs/install/). - - You can also install Yarn globally using npm: - ``` - npm install -g yarn - ``` - - After installing, you can verify the installation by running: - ``` - yarn --version - ``` - - This should display the installed Yarn version. - -2. **Fork the Project Repository:** - - - Fork the project repository to your GitHub account by clicking the "Fork" button at the top - right of the repository page. - -3. **Clone the Project Repository:** - - - Clone the project repository to your local machine using Git: - ``` - git clone https://github.com/your-username/project-repository-name.git - ``` - - Change into the project's `docs/` folder: - ``` - cd project-repository/docs - ``` - -4. **Install Dependencies:** - - - Inside the `docs/` folder, install project dependencies and start the server using: - ``` - yarn && yarn start - ``` - - This command should install project dependencies and start the server, automatically opening - the project's documentation in your default web browser. - -5. **Access the Documentation:** - - The local server should now be running, and you can view the documentation by navigating to: - ``` - http://localhost:3000/ - ``` - - This will open the documentation website locally, allowing you to browse and interact with the - project's documentation. - -#### Start Contributing: - -- After running the server, you can open the project in your preferred code editor, such as Visual - Studio Code. -- Make changes to the documentation files, and as you save them, you will see the updates reflected - in the browser window opened by the local server. - -### Example Commands: - -```bash -# Clone the repository -git clone https://github.com/your-username/project-repository.git -cd project-repository/docs - -# Install Yarn (if not already installed) -npm install -g yarn - -# Install project dependencies -yarn - -# Start the local server -yarn start -``` - -#### Notes: - -- Make sure to replace `your-username/project-repository` with the actual URL of the project - repository. -- These instructions assume you are running these commands in a terminal or command prompt. -- The local server typically runs on `http://localhost:3000/`, but it might vary depending on the - project configuration. diff --git a/docs/home/faq/docs-installation.mdx b/docs/home/faq/docs-installation.mdx index a970cfe84..1a715a394 100644 --- a/docs/home/faq/docs-installation.mdx +++ b/docs/home/faq/docs-installation.mdx @@ -8,135 +8,82 @@ image: https://docs.helium.com/img/link-image.png slug: /faq/docs-installation --- -# Helium Documentation Installation Guide +# Installation Guide: Running the Server Locally -Clone the docs repo from [Github](https://github.com/helium/docs). +#### Prerequisites: -```bash title="clone the repo" -$ git clone https://github.com/helium/docs.git -``` +- Node.js installed on your machine. You can download it from + [the official Node.js website](https://nodejs.org/). +- Yarn package manager installed. You can install it by following the instructions below: -Navigate to the `docs` directory +#### Steps (Assuming you have Node.js Installed): -```bash title="navigate to the docs directory" -$ cd docs/ -``` +1. **Install Yarn:** ---- - -## Prerequisites - -### Install Node.js - -Download and install the latest version of [Node.js](https://nodejs.org/en/download). - -```bash title="Verify the installation." -$ node --version -v18.16.0 -``` - -:::info - -Windows users installing Node.js do not need to install the `Compiler` nor `Chocolaty` dependencies. - -::: - -### Install Yarn - -After installing Node.js, npm will be installed and can be used to install Yarn. - -```bash title="install yarn" -$ npm install -g yarn -> yarn@1.22.11 preinstall /path/to/npm/node_modules/yarn -> :; (node ./preinstall.js > /dev/null 2>&1 || true) -``` - -To upgrade the Yarn version to be >= 1.5, set the project directory to version `berry`. - -```bash title="set yarn version to berry" -$ yarn set version berry -➤ YN0000: Retrieving https://repo.yarnpkg.com/3.5.1/packages/yarnpkg-cli/bin/yarn.js -➤ YN0000: Saving the new release in .yarn/releases/yarn-3.5.1.cjs -➤ YN0000: Done in 0s 430ms -``` - -### Install Dependencies + - Download and install Yarn by following the instructions on the + [Yarn website](https://classic.yarnpkg.com/lang/en/docs/install/). + - You can also install Yarn globally using npm: + ``` + npm install -g yarn + ``` + - After installing, you can verify the installation by running: + ``` + yarn --version + ``` + - This should display the installed Yarn version. -Install Yarn which will download and compile all the project module dependencies. +2. **Fork the Project Repository:** -```bash title="install yarn and dependencies" -$ yarn install -➤ YN0070: Migrating from Yarn 1; automatically enabling the compatibility node-modules linker 👍 + - Fork the project repository to your GitHub account by clicking the "Fork" button at the top + right of the repository page. -➤ YN0000: ┌ Resolution step -... -➤ YN0000: └ Completed in 4s 287ms -➤ YN0000: ┌ Fetch step -... -➤ YN0000: └ Completed in 9s 723ms -➤ YN0000: ┌ Link step -... -➤ YN0000: └ Completed in 8s 494ms -➤ YN0000: Done with warnings in 22s 635ms -``` +3. **Clone the Project Repository:** -Check the final version and confirm that it is >= 1.5 + - Clone the project repository to your local machine using Git: + ``` + git clone https://github.com/your-username/docs.git + ``` + - Change into the project's `docs/` folder: + ``` + cd docs/ + ``` -```bash title="verify yarn version" -$ yarn --version -3.5.1 -``` - ---- - -## Local Development - -```bash title="start the development server" -$ yarn start -[INFO] Starting the development server... -[SUCCESS] Docusaurus website is running at: http://localhost:3000/ - -✔ Client - Compiled successfully in 25.06s - -client (webpack 5.76.3) compiled successfully - -✔ Client - Compiled successfully in 542.45ms - -client (webpack 5.76.3) compiled successfully -``` - -This command starts a local development server and open up a browser window. Most changes are -reflected live without having to restart the server. - -### Auto Refresh - -Each time a file is saved the site will get rebuilt and the pages refreshed on the fly, there is no -need to keep restarting Yarn. - ---- +4. **Install Dependencies:** -## Link Checking Before Creating a Pull Request + - Inside the `docs/` folder, install project dependencies and start the server using: + ``` + yarn && yarn start + ``` + - This command should install project dependencies and start the server, automatically opening + the project's documentation in your default web browser. -Checking links can be accomplished by using the `yarn build` command +5. **Access the Documentation:** + - The local server should now be running, and you can view the documentation by navigating to: + ``` + http://localhost:3000/ + ``` + - This will open the documentation website locally, allowing you to browse and interact with the + project's documentation. -```bash title="make production build" -$ yarn build -[INFO] [en] Creating an optimized production build... +#### Start Contributing: -✔ Client +- After running the server, you can open the project in your preferred code editor, such as Visual + Studio Code. +- Make changes to the documentation files, and as you save them, you will see the updates reflected + in the browser window opened by the local server. -✔ Server - Compiled successfully in 30.22s +### Example Commands: -bigint: Failed to load bindings, pure JS will be used (try npm run rebuild?) +```bash +# Clone the repository +git clone https://github.com/your-username/docs.git +cd docs/ -✔ Client +# Install Yarn (if not already installed) +npm install -g yarn -● Server █████████████████████████ cache (99%) shutdown IdleFileCachePlugin - stored +# Install project dependencies +yarn -[SUCCESS] Generated static files in "build". -[INFO] Use `npm run serve` command to test your build locally. -``` +# Start the local server +yarn start diff --git a/local-server-guide b/local-server-guide deleted file mode 100644 index e69de29bb..000000000 From 64e748d419b30cfb8d79286249d76c923b7da7ff Mon Sep 17 00:00:00 2001 From: Ekemini Date: Thu, 29 Feb 2024 08:03:46 +0100 Subject: [PATCH 09/11] ran prettier formatting --- docs/home/faq/docs-installation.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/home/faq/docs-installation.mdx b/docs/home/faq/docs-installation.mdx index 1a715a394..18de569bb 100644 --- a/docs/home/faq/docs-installation.mdx +++ b/docs/home/faq/docs-installation.mdx @@ -87,3 +87,4 @@ yarn # Start the local server yarn start +``` From 1cc50f9391a7225b82ed33b21ad41b2862f369c6 Mon Sep 17 00:00:00 2001 From: Ekemini Date: Thu, 29 Feb 2024 08:12:44 +0100 Subject: [PATCH 10/11] run prettier formatting for contributing.md --- CONTRIBUTING.md | 48 ++++++++++++++++++++++++++---------------------- 1 file changed, 26 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a7f3e4f98..ecc3566c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,44 +1,48 @@ -# How to Contribute to this repository # +# How to Contribute to this repository -We value contributions from the community and will do everything we -can to get them reviewed in a timely fashion. If you have code to send -our way or a bug to report: +We value contributions from the community and will do everything we can to get them reviewed in a +timely fashion. If you have code to send our way or a bug to report: -* **Contributing Code**: If you have new documentation, fork this - repo, create a logically-named branch, and [submit a PR against this - repo](https://github.com/helium/docs). Include a - write up of the PR with details on what it does. +- **Contributing Code**: If you have new documentation, fork this repo, create a logically-named + branch, and [submit a PR against this repo](https://github.com/helium/docs). Include a write up of + the PR with details on what it does. -* To contribute to the documentation by setting up a server locally, visit [Contribution Guide: Setting Up Local Server for Documentation][local-server-guide]. +- To contribute to the documentation by setting up a server locally, visit [Contribution Guide: + Setting Up Local Server for Documentation][local-server-guide]. -* **Reporting Bugs**: Open an issue [against this - repo](https://github.com/helium/docs/issues) with as much - detail as you can. At the very least you'll include steps to - reproduce the problem. +- **Reporting Bugs**: Open an issue [against this repo](https://github.com/helium/docs/issues) with + as much detail as you can. At the very least you'll include steps to reproduce the problem. -# Contibuting a Helium Improvement Proposal (HIP) # +# Contibuting a Helium Improvement Proposal (HIP) -HIPs are modeled off Bitcoin Improvement Proposals (BIPs) and has become a standard in the crypto world for open source development on both technical and economic issues. +HIPs are modeled off Bitcoin Improvement Proposals (BIPs) and has become a standard in the crypto +world for open source development on both technical and economic issues. HIPs serve several primary functions: + - To make architecture changes - To make economic and token changes - To address cheating and security issues - To address meta-governance HIPs are not: + - Funding requests to The Helium Foundation - Foundation treasury management -* **How do I submit a HIP?**: Open a 'pull request' in the HIP repository. DO NOT create an 'issue'. Your pull request signifies a HIP in draft status. HIPs in draft status should be discussed in #hip-general in the [Helium Official Community](https://discord.gg/uTauMaJ2We). Draft HIPs will be addressed and managed by HIP editors. Please be sure to answer all of their questions appropriately. HIPs that do not work with HIP editors are seen as incomplete and are likely to be closed. Once your HIP is clear and has met all HIP requirements, HIPs are then open for deeper discussion with their own channels in the Official Helium Community. HIPs move to a vote after rough consensus that this HIP is appropriate for the community to vote on. There is never a guarantee your HIP will receive a channel or move to a vote. +* **How do I submit a HIP?**: Open a 'pull request' in the HIP repository. DO NOT create an 'issue'. + Your pull request signifies a HIP in draft status. HIPs in draft status should be discussed in + #hip-general in the [Helium Official Community](https://discord.gg/uTauMaJ2We). Draft HIPs will be + addressed and managed by HIP editors. Please be sure to answer all of their questions + appropriately. HIPs that do not work with HIP editors are seen as incomplete and are likely to be + closed. Once your HIP is clear and has met all HIP requirements, HIPs are then open for deeper + discussion with their own channels in the Official Helium Community. HIPs move to a vote after + rough consensus that this HIP is appropriate for the community to vote on. There is never a + guarantee your HIP will receive a channel or move to a vote. -This project is intended to be a safe, welcoming space for -collaboration, and contributors are expected to adhere to the -[Contributor Covenant Code of -Conduct](http://contributor-covenant.org/). +This project is intended to be a safe, welcoming space for collaboration, and contributors are +expected to adhere to the [Contributor Covenant Code of Conduct](http://contributor-covenant.org/). Above all, thank you for taking the time to be a part of the Helium Community. - - [local-server-guide]: docs/home/faq/docs-installation.mdx From c6ae0e74ff11a0ca43168db71c59be1966fbec19 Mon Sep 17 00:00:00 2001 From: Ekemini Date: Thu, 29 Feb 2024 08:50:30 +0100 Subject: [PATCH 11/11] change the installation link on readme.md path to match the same link as the one on contributing.md --- CONTRIBUTING.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ecc3566c6..006c6f754 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,4 +45,4 @@ expected to adhere to the [Contributor Covenant Code of Conduct](http://contribu Above all, thank you for taking the time to be a part of the Helium Community. -[local-server-guide]: docs/home/faq/docs-installation.mdx +- [local-server-guide]: docs/home/faq/docs-installation.mdx diff --git a/README.md b/README.md index e2dc9aa3e..60c334002 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Documentation for the Helium network. ## Installation -- [Installation Guide](https://docs.helium.com/home/faqdocs-installation/) +- [Installation Guide](./docs/home/faq/docs-installation.mdx) ## Contributing