Skip to content
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

Minor: Docs Enhancement (WIP) #1829

Open
wants to merge 24 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
405c21b
chore: enhanced about page of helium
nermalcat69 Feb 27, 2024
8b9c6f7
feat: enhancement in getting started page
nermalcat69 Feb 27, 2024
538ca1f
feat: some fixes and styling changes
nermalcat69 Feb 27, 2024
32da849
feat: getting started with helium page
nermalcat69 Feb 27, 2024
64b80a3
feat: sidebar change and slug change
nermalcat69 Feb 27, 2024
47e0e47
feat: helium history
nermalcat69 Feb 27, 2024
542fca5
feat: contributing enhancement
nermalcat69 Feb 28, 2024
b8a2316
feat: codeblock
nermalcat69 Feb 28, 2024
9caaf32
feat: yarn lock fix
nermalcat69 Feb 28, 2024
cedcfb7
feat: yarn lock match
nermalcat69 Feb 28, 2024
a666b6c
chore: unnecessary package-lock file
nermalcat69 Feb 28, 2024
9b58f60
chore: replaced "Helium App" with the specific app
nermalcat69 Feb 28, 2024
03bb744
chore: updated faq security as per the solana migration
nermalcat69 Feb 29, 2024
df43dd3
chore: cleaning up in security.mdx
nermalcat69 Feb 29, 2024
d133351
feat: new header images
nermalcat69 Feb 29, 2024
0bdf28d
chore: build on network faq as per the migration
nermalcat69 Feb 29, 2024
3c49547
feat: unnecessary legacy content banner here
nermalcat69 Feb 29, 2024
33a7a52
chore: implemented the proposal from #1703
nermalcat69 Feb 29, 2024
735ba9b
chore: enhancement in setting up a hotspot
nermalcat69 Feb 29, 2024
2f3062f
feat: update lorawan-on-helium.mdx
nermalcat69 Feb 29, 2024
0a0a082
Merge branch 'master' into nermo
nermalcat69 Mar 7, 2024
da0e3de
chore: error fixing
nermalcat69 Mar 23, 2024
d5b9a04
chore: error fixing
nermalcat69 Mar 23, 2024
ffd5402
Merge branch 'master' into nermo
nermalcat69 Mar 23, 2024
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
73 changes: 54 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,73 @@
# 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:
1. **Git Clone the Project**: Clone the repository to your local machine using the git clone command
followed by the repository URL. This will create a local copy of the project on your machine. bash
```git clone https://github.com/helium/docs```

* **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.
2. **Make the Changes**: Navigate to the project directory and make
the necessary changes to the code, documentation, or any other relevant files using your preferred
text editor or IDE. Commit the Changes: Once you've made the desired modifications, stage the
changes using the git add command followed by the filenames or directories of the modified files.
```git commit -m "Brief description of the changes made"```

* **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.
3. **Open a Pull Request (PR)**: Push your committed changes to your fork of the repository using the git push command.
Then, navigate to the original repository on the hosting platform (e.g., GitHub, GitLab) and open a
pull request to merge your changes into the main branch of the original repository. bash

# Contibuting a Helium Improvement Proposal (HIP) #
```git push origin <branch_name>```

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.

4. Pull Request (PR) Guidelines: Provide a clear title and description for your pull request, detailing
the purpose of the changes. If your changes address any specific issues or feature requests,
reference them in the pull request description using keywords like "closes #<issue_number>". Ensure
that your changes adhere to any contribution guidelines specified by the project maintainers. If
necessary, include screenshots, test results, or any other relevant information to assist the
reviewers in understanding your changes.

5. **Collaborate and Iterate**: Be prepared to address any
feedback or requests for changes from the project maintainers during the review process. Collaborate
with them to refine your contribution and ensure its alignment with the project's goals and
standards. By following these steps, you can effectively contribute to the project while adhering to
best practices for version control and collaborative development.

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.

- **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)

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.
71 changes: 0 additions & 71 deletions docs/home/about-helium.mdx

This file was deleted.

107 changes: 107 additions & 0 deletions docs/home/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
---
id: about-helium
hide_title: true
title: Home
pagination_label: About Helium
sidebar_label: About Helium
description: What is Helium?
image: https://docs.helium.com/img/link-image.png
slug: /home/about-helium
hide_table_of_contents: true
---

import useBaseUrl from '@docusaurus/useBaseUrl'

# What is Helium?

<img className="docsheader" src={useBaseUrl('img/home/blockchainicon.png')} />

Helium Network is a decentralized, blockchain-backed wireless network project that leverages LoRaWAN
technology. It incentivizes individuals and organizations to set up and manage wireless networks
through token rewards. Currently, Helium integrates with 5G networks, using the Solana blockchain as
its foundation. The network's primary utility token is HNT, supplemented by IOT and MOBILE tokens
which facilitate the operation of LoRaWAN and 5G networks.

> In essence, the Helium network offers a decentralized, distributed system of Hotspots that
> eliminates the need for traditional internet service providers and centralized authorities that
> monitor your activity and levy costly fees.

---

By joining the Helium network, you not only gain access to affordable connectivity but also have the
opportunity to be rewarded for participating as a miner on their network. Helium is just trying to
build a better future for the newer generation well watch this
[video](https://www.youtube.com/watch?v=Vx9YyS7-d3g).

An interesting aspect of Helium is its exemplary use of blockchain technology in real-world
applications as a DePIN project. DePIN, short for Decentralized Physical Infrastructure Networks,
leverages decentralized technology for practical applications such as street mapping, rendering
power, cab-hailing services, and more.

Helium's focus is on enhancing wireless networks through a growing collection of user-owned
hotspots. These hotspots enable communities to improve their internet and cell coverage
independently of traditional telecom companies. Helium employs a unique consensus algorithm known as
Proof-of-Coverage (PoC) in its subnetworks.

<img src={useBaseUrl('img/migration/migrationheader.png')} />

On April 18, 2023, Helium transitioned from its independent blockchain network to the Solana
blockchain. Read More about the [Solana Migration](/solana/migration). This significant move
represents one of the largest layer 1 blockchain migrations to date, bolstering the expansion of the
world's largest decentralized wireless network. Helium's migration to Solana could potentially
stimulate growth across the entire DePIN sector.

> As Daly explains, "Helium really represents the first DePIN business that things could be built on
> top of." This is just the beginning. Solana's interoperable ecosystem, coupled with its low costs
> and scalable innovations such as compressed NFTs, could pave the way for new, decentralized,
> community-run infrastructure for businesses and users.

---

## Helium Network Components

**Solana Blockchain:** The underlying blockchain infrastructure that provides security, scalability,
and decentralization for the Helium Network.

**HNT Token:** The native token of the Helium Network, which is used to incentivize network
participants and facilitate transactions.

**IOT Token:** A token specific to the LoRaWAN network, enabling low-power, wide-area network
connectivity for Internet of Things (IoT) devices. PoC is employed for the LoRaWAN subnetwork.

**MOBILE Token:** A token specific to the 5G network, facilitating high-speed mobile connectivity
and data transmission. PoC is employed for the 5G subnetwork.

Through these components, the Helium Network is revolutionizing the network industry in web3 using
solana blockchain.

## Network Participants

**Hotspot Owners:** Individuals or organizations that deploy and maintain Helium-compatible wireless
devices (Hotspots) to provide network coverage.

**IoT Device Owners:** Users of IoT devices that leverage the Helium Network for connectivity.

**Mobile Device Users:** Users of mobile devices that access the 5G network through the Helium
Network infrastructure.

**Developers:** Individuals or organizations that build applications and services using the Helium
Network infrastructure.

## Key Features

**Decentralized Infrastructure:** The Helium Network allows for the creation and maintenance of a
distributed wireless network by incentivizing participants to contribute resources and share the
benefits.

**Scalable and Secure:** The Helium Network leverages the Solana Blockchain, which is known for its
high scalability, low latency, and robust security.

**Multi-Use Case Support:** The Helium Network supports various use cases, including IoT devices
through the LoRaWAN network and high-speed mobile connectivity via the 5G network.

**Incentivized Participation:** The Helium Network employs a token-based system to reward
participants and encourage network growth.

**Proof-of-Coverage (PoC):** A unique consensus algorithm employed by the LoRaWAN and 5G
subnetworks, which rewards participants for verifying wireless network coverage.
14 changes: 7 additions & 7 deletions docs/home/helium-history.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ import useBaseUrl from '@docusaurus/useBaseUrl'

# History of the Helium Network

import LegacyContentBanner from '@site/src/theme/LegacyContentBanner'

<LegacyContentBanner />

## Founding and Early Vision

The Helium Network was founded in 2013 by Amir Haleem, Shawn Fanning, and Sean Carey. The founders
Expand All @@ -41,9 +37,13 @@ wireless infrastructure provider.

## Transition to Solana Blockchain

To improve scalability, security, and decentralization, the Helium Network migrated to the Solana
blockchain. This transition allowed Helium to leverage the high-performance capabilities of Solana,
which was crucial for supporting the increasing number of network participants and transactions.
On April 18, 2023, the Helium Network transitioned to the Solana blockchain. This shift enabled
Helium to tap into Solana's high-performance capabilities, critical for supporting the growing
number of network participants and transactions. This move to Solana has considerably enhanced the
scalability, security, and decentralization of the network, placing Helium as a front-runner in the
decentralized wireless infrastructure arena.



## Introduction of Subnetworks and New Tokens

Expand Down
Loading