helium / docs Goto Github PK

Helium Wallet, Helium Utility, Various Community Apps

internal story id: 8350

There are a few of these that were ported over. Now that we support it, we should remove them.

Internal id: 9401

Internal id: 8941
sprint 43

internal story id: 9372
sprint 43

Internal id: 9400

internal ref: 9235

Waiting on links from Pete with images / assets, as well as style guide.

Internal story id: 8941

First line should read:
To add a device, go to Devices and click the + Add New Device icon on the top right of the window.

On First question under Important information,
hyperlink is missing on word here.

Internal id: 9417
sprint 44

A list of which chain vars impact POC and what they mean.

Going to leave this initial piece to @kent-williams

Doc on styling instructions here.

@PeterMain If you could review the basics here please. We can update the infima color values to start and see how far that will take us.

Document:

• Enabling 2FA
• Generating API key

We have the opportunity to add link preview images on an individual doc basis or a global default if nothing is specified in the docs.

Global Default:
https://v2.docusaurus.io/docs/api/themes/configuration#meta-image

Doc Specific:
image:
https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-frontmatter

The transaction fee page: https://developer.helium.com/blockchain/transaction-fees uses an example transaction: https://explorer.helium.com/txns/RP8xdjuYsvIAaEuyNvMmlBF7Kc8ShNoURtA1ccgMGpk

1. The doc does not line up in fees with the linked transaction
2. The doc is missing the overhead of the transaction envelope as part of the fee (which explains why the result is different)

Make sure that the new docs here do it right?

Press Kit: https://drive.google.com/drive/folders/1ujKIMp1I8g8rufsXs2MJlXFP69hjCejH

internal id: 9419
sprint 44

Found some small wording errors while reading the Docs, here's what I've found so far and where it would need to be corrected, all in asterisks.

Page: https://docs.helium.com/
-Helium is a global, distributed network of Miners that create public, long-range wireless coverage for LoRaWAN-enabled IoT devices. Miners produce and are compensated in $HNT, the native cryptocurrency of the Helium blockchain. The Helium blockchain is a new, open-source, public blockchain created entirely to incentivize the creation of physical, decentralized wireless networks. Today, the Helium blockchain, and its thousands of miners, provide access to the largest, public LoRaWAN Network in the world.

Page: https://docs.helium.com/blockchain/proof-of-coverage
-As of HIP 15, Proof of Coverage relies entirely on beaconing. A beacon is a single transmission witnessed by any Hotspot.

Page: https://docs.helium.com/blockchain/consensus-protocol
-A new Consensus Group (CG) is elected once per epoch based on a combination of factors.

Page: https://docs.helium.com/blockchain/helium-token
-Hotspot Hosts and Network Operators. Hosts mine HNT while deploying and maintaining network coverage.
-Data Credits, which are a $USD-pegged utility token derived from HNT in a burn transaction, are used to pay transaction fees for wireless data transmissions on the network (in addition to things like adding Hotspots and sending).

This is all I found while organizing the draft of the FAQ but will also do a full read soon and add anything else I see. Looking forward to Docs going live :-). Great work!

CMC, Coingecko, Messari, etc.

Waiting on trackingID

Internal story id: 8807

internal story id: 8807

Internal story id: 8995

Internal id: 9416
Sprint 43

Should be "ready-to-use", not "read-to-use"

Overview

Devices

• Devices overview
• Adding new devices
  • Manually adding devices
  • Importing multiple devices
  • Importing devices from The Things Network
• Managing devices
  • Device Index overview
  • Adding and removing Labels
  • Searching for devices
  • Using the Quick Action menu
  • Pausing, Activating Devices
  • Editing display/view
  • Viewing live device data
• Event logs and debugging
  • Managing event logs
    • Displaying
    • Exporting JSON files
  • Using Debug mode
    • Viewing
    • Exporting JSON files
    • Refreshing
    • Clearing

Labels

• Labels overview
• Adding and removing Labels
  • Devices
  • Integrations
  • Functions
• Managing Labels
  • Swapping Labels
  • Deleting Labels

Integrations

• Integrations overview
• Adding Integrations:
  • Prebuilt
  • HTTP
  • MQTT
  • AWS IoT
• Managing Downlinks
  • Downlink URLs, Keys
  • Manual Downlink
• Managing Integrations
• Adding and removing Labels

Functions

• Functions overview
• Creating Decoder functions
  • Prebuilt
  • Custom
• Adding and removing Labels
• Managing Functions

Data Credits

• Data Credits overview
• Managing Data Credits
  • Acquiring with Credit Card
    • Setting up auto payment
    • Adding additional credit cards
  • Acquiring with $HNT
  • Transferring DC to Organizations

Organizations and Users

• Organization overview
• Managing Organizations
  • Adding
  • Switching
  • Deleting
• Users overview
• Managing users
  • Inviting
  • Changing permissions
  • Removing

Settings

• Enabling 2FA
• Generating API key

It would be good to have the PlatformIO examples incorporated into the new doc set.
https://github.com/helium/longfi-platformio

A couple of things missing from the new doc set, or if there are not found via search

Regional Channels & Data Rates:
https://github.com/helium/devdocs/blob/master/longfi/regional-channels.md

It's helpful to have this info all in one nice area as found in the old doc set. It is US915 specific, so perhaps making growth allowance for the same region info for other Non US915 regions would be good as well.

MAC Commands, FOpts, ADR, FCnt:
https://github.com/helium/devdocs/blob/master/longfi/mac-commands-fopts-adr.md

This could perhaps meld in with where the ADR discussion is, although it's not just ADR.
The behavior around what the initial LinkAdrReq is for and that it will repeat if not ack'd is helpful.
Might re-emphasize the initial REQ is not intended to modify Data Rate or Power. I "guess" it does return values that were found in the corresponding uplink??
And that subsequent LinkAdrReq's might be received per ADR.

Goal: bring over intercom articles that covers mobile app usage, network troubleshooting, FAQ, tabs, etc and consolidate in one place.

Proposed new top-level menus:

Hotspot App

• User Guide
  • what is this app
  • what you can do
  • Hotspot Tab
  • Wallet Tab
  • Notification Tab
  • Settings
• Onboarding Account
• Onboarding Hotspot
• Network Troubleshooting
• FAQ
• etc

Wallets

• Hotspot App
• CLI
• Ledger

Internal id: 8631
sprint 43

Doc error I spotted
https://developer.helium.com/blockchain/proof-of-coverage#the-role-of-witnesses
"Currently there is a limit of five witnesses per challenge packet layer."

Isnt that now set to a limit of upto 25 witnesses sharing 4 reward units?

internal id: 9436
sprint 44

(include info on verifying request coming from helium by using the webhook key on the Organization table to decode the header X-Helium-Hmac-SHA256 which contains the body of the request which has been encoded w/ the webhook key)

Currently the doc ids are used for the link preview titles because there are no doc titles in the header. This results in the link preview and bottom doc nav using the ids instead of the titles.

We should add titles and very short descriptions to the top of each doc using the description: and 'title' field.
https://v2.docusaurus.io/docs/markdown-features#markdown-headers

internal id: 9235
sprint: 44

Internal story id: 9026

These just need some updating:

• Organization overview
• Managing Organizations
  -- Adding
  -- Switching
  -- Deleting
• Users overview
• Managing users
  -- Inviting
  -- Changing permissions
  -- Removing

Internal story id: 8878

Currently Blank: /mine-hnt/convert-lorawan-gateway

internal id: 9309

Style appropriately if needed.
Instructions: https://v2.docusaurus.io/docs/search#styling-your-algolia-search

Currently Blank: /use-the-network/network-servers

I walked though all of Devices->Ready To Use and Devices->Development Devices checking for valid links. Following problems found

NOTE: The next two problems hit the same files in "Devices->Development Devices"

Problem 1:
Someone in Arduino land got cute, changed "linux" to "Linux"
At "Getting the Arduino IDE for Linux" the "Linux" link is bad (note case of the L in Linux)
is:
https://www.arduino.cc/en/Guide/linux/
should be:
https://www.arduino.cc/en/Guide/Linux/

This hits the following:
https://docs.helium.com/use-the-network/devices/development/heltec-cubecell-htcc-ab01/arduino
https://docs.helium.com/use-the-network/devices/development/st-b-l072z-lrwan1/arduino
https://docs.helium.com/use-the-network/devices/development/sparkfun-pro-rf/arduino
https://docs.helium.com/use-the-network/devices/development/adafruit-feather-m0-rfm95/arduino
https://docs.helium.com/use-the-network/devices/development/heltec-wifi-lora-32-v2/arduino

Problem 2:
Looks like a link to integration doc is incorrect of missing at end if the doc at the following:
" The next step is to learn how to use your device data to build applications, visit our Integrations docs here."
"here" has a link back to itself in the ST doc, no link at all in the others.
This hits the following:
https://docs.helium.com/use-the-network/devices/development/heltec-cubecell-htcc-ab01/arduino
https://docs.helium.com/use-the-network/devices/development/st-b-l072z-lrwan1/arduino
https://docs.helium.com/use-the-network/devices/development/sparkfun-pro-rf/arduino
https://docs.helium.com/use-the-network/devices/development/adafruit-feather-m0-rfm95/arduino
https://docs.helium.com/use-the-network/devices/development/heltec-wifi-lora-32-v2/arduino

Problem 3:
Devices -> Ready To Use Devices ->
file: https://docs.helium.com/use-the-network/devices
The first link, to the LoRaWan spec is broken
Bad link: https://lora-alliance.org/sites/default/files/2018-05/lorawan1_0_2-20161012_1398_1.pdf

Problem 4:
Adeunis Field Test Device:
file: https://docs.helium.com/use-the-network/devices/ready-to-use/adeunis-field-test-device
link to "Manual" is bad
Bad Link: https://www.adeunis.com/wp-content/uploads/2019/12/FTD_LoRaWAN_US902-928_UG_GB_V1.0.0.pdf

Problem 5:

Dragino LHT65
file: https://docs.helium.com/use-the-network/devices/ready-to-use/dragino-lht65
link to "Manual" is bad
Bad link: https://www.dragino.com/downloads/downloads/LHT65/LHT65_Temperature_Humidity_Sensor_UserManual_v1.7.1.pdf

A list of the HIPs that impact POC and what they do precisely.

Internal draft here.

https://docs.google.com/document/d/1GCRbZu6i7InIgnQvBtJsQRGYtS6ND_xwTWkUXmPBxTU/edit?ts=600f77c6#

Internal story id: 8901