Skip to content

Latest commit

 

History

History
79 lines (57 loc) · 4.29 KB

documentation.mdx

File metadata and controls

79 lines (57 loc) · 4.29 KB
Raw
title description
Documentation
When you submit an app, you need to submit documentation about your app's APDUs and status words and to submit the user's documentation.

import { Callout } from 'nextra/components'

Documentation

The requirement is to document your app's APDUs and status words on the app's repository (A)
and to submit the user's documentation in a Google Doc format for review or a URL to the already published documentation (B).
If it is already published, ensure it follows the instructions below.

A. APDUs and Status words

Your device app repository must have a docs folder in which you will document the APDUs and corresponding errors, taking example on the Bitcoin App.

For the ranges available, follow the stated ranges in the SDK.

Name this file apdu.md and put it under the docs folder of your app.

B. Users documentation

Introduction

Proper documentation is crucial for the approval and release of your app. Ensure your documentation is complete and follows Ledger's guidelines.

It is required for third party teams to provide and host a complete tutorial for users before the app is released on the Ledger Manager. Here are the rules for writing this documentation and it should be followed very carefully.

Ledger Documentation

Follow the recommended writing style for clear and concise documentation. Short sentences, actionable instructions, and proper terminology are key to effective communication.

Your documentation must follow the requirements below so that Ledger uses a solid common documentaion basis. Ledger Customer Support will write and publish an article (example) that describes:

  • Short introduction: what the app does, what crypto assets it can manage, using what service. Who has developed it. Ledger Nano S, Nano X and Nano S Plus supported?
  • Requirements: What’s needed before starting.
  • Installation instructions: How to install the app using Ledger Live.
  • Next steps: link to third party documentation and where to get support.

Content

The article (example) must describe:

  • Short introduction: what the app and service do, what crypto assets they can manage, why to use a Ledger device, where to get support.
  • Requirements: What’s needed before starting.
  • Installation instructions: How to install the app using Ledger Live.
  • Setup instructions:
    • For a web app: how to connect the Ledger device.
    • For installable app: how to download and install it, how to connect to it.
  • Where to view account balance.
  • How to receive crypto assets
    • Document all the steps.
    • Explicitly instruct to verify receive addresses on the device.
  • How to send crypto assets
    • Document all the steps and form fields to fill.
    • Explicitly instruct to verify transaction details on the device display, before confirming and signing it.
  • Support: where to get help if needed (mail address, Slack/Reddit/Telegram communities).
  • Since you will host the final version of the document you are required to prepare the URL address and include it clearly in the Google Doc.

Style

  • Write short and concise sentences.
  • Write clear section titles.
  • Give actionable instructions: Click this, enter that. Verify this, confirm that.
  • Use text formatting for UI text, example: Your device displays BTC app installed.
  • Screenshots can support the instructions if the user interface is complicated.
  • Referring to the hardware wallet: Ledger Nano S, Ledger Nano S device, device, hardware wallet, Ledger hardware wallet, Ledger device. Strictly avoid: wallet, Ledger wallet, a Ledger.
  • Referring to crypto assets: name, ticker, crypto asset(s), coin(s), cryptocurrency. Please avoid: money.
  • Be sure to check this article for an example.