Repository files navigation

Documentation for the Helium network.

• Node.js version >= 10.15.1

• Yarn version >= 1.5

• Installation Guide

Documentation is managed by Helium, but supported by the community.

Please seeCONTRIBUTING.md for more instructions.

When authoring a new doc, be sure to applyprettier to it during review. For example:npx prettier --write --prose-wrap always docs/blockchain/new_doc.mdx

It will apply appropriate line wraps and other formatting niceties.

When editing an existing doc, line wrap should not be applied (don't runprettier), and lines thatrun wider than 80 chars in width are okay. Applyingprettier would cause many unimportant linechanges and make review more difficult.

Instead, from time to time,prettier will be run against the documents and those unimportantcommits will be added to.git-blame-ignore-revs

Use the style guide foundhere to learn what markdown syntax is available.

For more advanced content consider usingJSX.

When linking to other docs always use full path links or abbreviated links to full path links at thebottom of the doc. Abbreviated links help improve readability of the raw markdown and makes commonlinks reusable in the same doc.

Abbreviated Links Example: If you would like to link to the development devices introduction pagefound at/network-iot/devices/development, use[development devices][devices.development] inlinewith your text content. Next, create the link to the full path at the very bottom of the docmarkdown like this[devices.development]: /network-iot/devices/development.

When adding images, use the method shown below.

---id: my-doctitle: My Doc---# Doc Title// Add to the top of the file below the front matter and title.import useBaseUrl from '@docusaurus/useBaseUrl';...<img alt="Image Description" src={useBaseUrl('img/image.svg')} />

When naming images with multiple words, use- to separate the words only.

Create a new *.mdx extension file following the existing naming conventions.

When creating a new doc, use the following front matter at the very top of the doc with thefollowing fields:

id: This should match the filename without the extension.title: The title of your document.If this field is not present, the document's title will default to its id.description: Thedescription of your document.sidebar_label: This should match id name but with spaces andcapitalized first letters.

---id: devicestitle: Devicesdescription: Learn about Helium Devicessidebar_label: Devices---

slug: If the doc id path has repeated sections like the following doc pathnetwork-iot/devices/devices, define aslug: field in the front matter to make it pretty as shownbelow. This way when this doc is navigated to, the URL shown will not have repeating sections namesin it.

slug: network-iot/devices

yarn build does a good job of checking for dead links.

Learn how to create sidebar linkshere.

When adding items use the raw id path, slug paths will not work.

This website is built usingDocusaurus 2, a modern static websitegenerator.