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

Closed
wants to merge 24 commits into from
Closed
Show file tree
Hide file tree
Changes from all 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.
4 changes: 2 additions & 2 deletions devblog/2020-08-27-console-updates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ transactions will appear on the Console Data Credits page and the Data Credit ba
updated accordingly.

On Console, users choose the Data Credit amount they want to add to their account and select Burn
HNT to DC. This burn action can be accomplished using either the Helium App or the Helium Wallet CLI
HNT to DC. This burn action can be accomplished using either the Helium Wallet App or the Helium Wallet CLI
Tool:

- On the Helium App (v2.2.0 or above), tap Send and open the QR code scanner located on the top left
- On the Helium Wallet App (v2.2.0 or above), tap Send and open the QR code scanner located on the top left
of the screen.
- To use the Wallet CLI tool, follow the directions
[here](https://developer.helium.com/blockchain/blockchain-cli#burn).
Expand Down
2 changes: 1 addition & 1 deletion devblog/2020-11-23-app-version-270.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ authors: [cokes518]
Wallet/Account and associated Hotspots if a user directly upgrades from 2.6.1 to 3.x.x. as a
restore from the deprecated secure store will no longer be supported. This is also a good reminder
to write down the 12 words used to generate the wallet's private key. You can find those 12 words
by launching the Helium App > More > Advanced > Reveal 12 Words.
by launching the Helium Wallet App > More > Advanced > Reveal 12 Words.

<!--truncate-->

Expand Down
2 changes: 1 addition & 1 deletion devblog/2021-01-26-app-version-290.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Hotspots and manufacturers.

<!--truncate-->

We’re happy to announce another step in completing this initiative - the Helium App is now updated
We’re happy to announce another step in completing this initiative - the Helium Hotspot App is now updated
to support new onboarding accounts for Helium and Cal-Chip Connected Devices.

Please update your app to v2.9.0 for all Hotspot onboarding. Those who try to onboard with an older
Expand Down
4 changes: 2 additions & 2 deletions devblog/2021-03-04-console-updates-1.7.0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ authors: [jdgemm]
---

We’re excited to announce the release of Helium Console under the Apache 2.0 license. Console joins
a growing list of Helium open source projects including blockchain core, the wallet, the blockchain
explorer, the Helium app and others
a growing list of Helium open source projects including blockchain core, the Helium wallet, the blockchain
explorer, the Helium Hotspot app and others

<!--truncate-->

Expand Down
4 changes: 2 additions & 2 deletions devblog/2021-04-06-api-retrospective/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ services also depend on this API.

### Root Cause:

In the development of Explorer and the Helium App, we rapidly deployed new features that gave
In the development of Explorer and the Helium Wallet App, we rapidly deployed new features that gave
insight to new users to the network. Useful information such as daily rewards, rewards overtime, and
Hotspot checklists, were not optimized for scale.

Expand Down Expand Up @@ -47,7 +47,7 @@ outage. This is colloquially known as a thundering herd.

## Additional Communication:

We’ve added a Network Status banner notification in the Helium app that appears when an incident is
We’ve added a Network Status banner notification in the Helium Hotspot app that appears when an incident is
reported. This update is available in 3.0.6.

![banner](./banner.png)
Expand Down
6 changes: 3 additions & 3 deletions devblog/2021-10-21-app-version-370.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ App Version 3.7.0

## StakeJoy as API Provider

We've added StakeJoy API support to the Helium App. StakeJoy provides data to explorer.helium.com
and now the Helium app to provide users with an improved experience. To use StakeJoy, go to
**Settings**, tap **Choose API Provider** and select **StakeJoy**.
We've added StakeJoy API support to the Helium Hotspot App. StakeJoy provides data to
explorer.helium.com and now the Helium Hotspot app to provide users with an improved experience. To
use StakeJoy, go to **Settings**, tap **Choose API Provider** and select **StakeJoy**.

<!--truncate-->

Expand Down
2 changes: 1 addition & 1 deletion devblog/2021-11-30-network-outage-post-mortem.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ Around 2021-11-20 18:30 UTC, the team identified a subset of Hotspots with 1GB o
be able to ingest the block. At this point, the Discovery Mode router had several more open state
channels that could potentially become degraded and cause long blocks.

To avoid future degradation of the Network, the Helium App team decided to disable the Discovery
To avoid future degradation of the Network, the Helium Hotspot App team decided to disable the Discovery
Mode feature until further notice. An app notification, status incident, and announcement on Discord
regarding the large block and disabling of Discovery Mode were sent. During the day, additional
progress updates were also posted on https://status.helium.com and Discord ​​as the team continued
Expand Down
2 changes: 1 addition & 1 deletion devblog/2021-12-07-app-version-385.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ require the user to re-enter all 12 words instead of challenging 3 random words.

## Maker Account Deeplinking and Transaction Signing

We've added support in the Helium app to sign transactions on behalf of Maker apps (or other apps)
We've added support in the Helium Wallet app to sign transactions on behalf of Maker apps (or other apps)
to reduce the amount of times a user will have to re-enter their seed phrase. This also ensures no
private keys are leaked to apps unofficial to the Helium Network.

Expand Down
4 changes: 2 additions & 2 deletions docs/architecture/hexagons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ parent resolution 8 hexagon.

## Resolution 8 Hexagons

The Helium app displays resolution 8 hexagons, which have an area of 0.7373276 km², and edge length
The Helium Hotspot app displays resolution 8 hexagons, which have an area of 0.7373276 km², and edge length
of 0.461354684 km. About 130 resolution 8 hexagons cover the city of San Francisco.

:::note
Expand Down Expand Up @@ -196,7 +196,7 @@ selecting an empty hexagon will not mean the Hotspot will mine more.

**Q: Why are there hexagons now instead of exact Hotspot locations?**

A: To protect Hotspot owner's privacy, the Helium app and Explorer will use hexagons instead of
A: To protect Hotspot owner's privacy, the Helium Hotspot app and Explorer will use hexagons instead of
precise locations to display coverage.

**Q: Why is my Hotspot location so far off from the center of the hexagon?**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ payments, and burn HNT. It will also continue to support the original Helium Hot

## Starter App features

- Supports deeplinking and transaction signing through the Helium app
- Supports deeplinking and transaction signing through the Helium Wallet app
- Simply put: users of the Maker app will not need to sign in with their 12 words, as long as they
are signed in with the Helium app
are signed in with the Helium Wallet app
- Hotspot onboarding with Bluetooth
- Hotspot onboarding with QR Code
- Setting Wi-Fi credentials for Hotspots onboarded with Bluetooth
- Assert Location (Bluetooth and QR Code)
- Generating any required transactions for the Helium app to sign (`add_gateway`, `assert_location`,
- Generating any required transactions for the Helium Wallet app to sign (`add_gateway`, `assert_location`,
`transfer_hotspot_v2`)
- Submit signed transactions to the blockchain
- A settings menu with PIN code, language selector, and the linked Helium address displayed
Expand Down Expand Up @@ -88,7 +88,7 @@ to the Helium team.
## QR Code Onboarding

QR Code Onboarding allows Makers to generate a partial `add_gateway` transaction outside of the
Helium App. Users use the camera in the Helium App to add this type of Hotspot.
Helium App. Users use the camera in the Helium Hotspot App to add this type of Hotspot.

To select QR Onboarding, in the `hotspot.ts` file, specify `QR` in `onboardType`.

Expand All @@ -113,7 +113,7 @@ To select QR Onboarding, in the `hotspot.ts` file, specify `QR` in `onboardType`
## Web Onboarding

Web Onboarding allows Makers to generate a partial `add_gateway` transaction outside of the Maker
App. Makers generate a deep link back to the Helium App/Maker App to finish the `add_gateway`
App. Makers generate a deep link back to the Helium Wallet App/Maker App to finish the `add_gateway`
transaction. [Read more about deep linking](/deep-links-and-qr-codes).

To select Web onboarding, in the `hotspot.ts` file, specify `web` in `onboardType`.
Expand Down Expand Up @@ -165,7 +165,7 @@ the blockchain, the transaction will be discarded as the payer address does not
blockchain’s `chain_var` of valid addresses. This ensures no Data Credits are spent on testing, but
allows trial and error as Makers finish app integration.

Once you have the transaction, you will pass it onto the Helium app to sign the transaction. Once
Once you have the transaction, you will pass it onto the Helium Wallet app to sign the transaction. Once
submitted, you can view the pending transaction using this API:

- [https://api.helium.io/v1/accounts/138LbePH4r7hWPuTnK6HXVJ8ATM2QU71iVHzLTup1UbnPDvbxmr/pending_transactions](https://api.helium.io/v1/accounts/138LbePH4r7hWPuTnK6HXVJ8ATM2QU71iVHzLTup1UbnPDvbxmr/pending_transactions)
Expand All @@ -184,7 +184,7 @@ The output is a JSON object:
}
```

The `txn` output is then passed onto the Helium App over BLE, in QR code format, or through a deep
The `txn` output is then passed onto the Helium Wallet App over BLE, in QR code format, or through a deep
link in this format: `helium://add_gateway/<txnoutput>?mac=<macaddress>`

:::warning
Expand Down
24 changes: 20 additions & 4 deletions docs/architecture/solana/migration/ledger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ description: Ledger Hardware Wallet User Documentation
slug: /solana/migration/ledger
---

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

<LegacyContentBanner />

## Video Walkthrough

import { YouTube } from 'mdx-embed'
Expand Down Expand Up @@ -67,6 +63,26 @@ import { LedgerMigration } from '@theme/LedgerMigration'

<LedgerMigration />

## Verification Step

After completing the migration, it's crucial to verify that the process was successful. Here's how
you can do it:

Find the public address associated with your pre-migrated account. You can do this by checking the
account details in your Ledger Live application or through the Solana blockchain explorer. Search
for your old public address on Solana Explorer and ensure the account has no funds. This step
confirms that all funds have been successfully migrated. Find the public address associated with
your post-migrated account. This can be done by checking the account details in your Ledger Live
application or through the Solana blockchain explorer. Search for your new public address on Solana
Explorer and ensure the account has some funds. This step confirms that the migration was successful
and that your funds are now available on the Solana blockchain.

## Note on Staked HNT

It's important to note that any staked Helium Network Tokens (HNT) will be migrated to a single
veHNT token. This change is part of the migration process to ensure compatibility with the Solana
blockchain. For more information on the veHNT token, please refer to the veHNT documentation.

---

## Derivation Paths and your new Public Key
Expand Down
Loading