Helius Documentation

Comprehensive developer documentation for Helius APIs and services. Built with Mintlify and supporting multiple languages.

Features

• Multi-language support (English, Chinese)
• Custom sitemap with hreflang tags for SEO
• API reference documentation
• Comprehensive guides and tutorials
• Interactive code examples

Local Development

1. Install the Mint CLI:

npm i -g mint

2. Start the dev server from the repository root (where docs.json is):

mint dev

3. Open your browser at the URL printed in the console.

Internationalization

We use Lingo.dev for translation management:

# Prepare and run translations
npm run i18n

# Generate translations (force update)
npm run i18n:force

SEO & Sitemap

We maintain a custom sitemap with hreflang tags for optimal international SEO. The sitemap is automatically regenerated after translations via GitHub Actions.

# Generate sitemap manually (if needed)
npm run sitemap

The sitemap regenerates automatically when:

• Translations run via GitHub Actions
• You can also run manually after adding/removing pages

Available Scripts

• npm run dev - Start Mintlify development server
• npm run i18n - Run translation workflow
• npm run sitemap - Generate sitemap.xml with hreflang tags

Publishing Changes

Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.

Contributing

• Read CONTRIBUTING.md before opening a PR.
• Edit English source files only. Do not edit zh/; it is autogenerated.
• Follow the Mintlify writing and accessibility rules in this repo.

i18n

• English is the source of truth.
• The zh/ directory is generated by our translation pipeline and should not be changed manually.

Analytics

• PostHog is configured in docs.json using a public key that is safe to commit.

License

Apache-2.0 © Helius Blockchain Technologies Inc.

Trademarks and assets

Helius names, logos, and brand assets in logo/ are trademarks of Helius Blockchain Technologies Inc. and are not covered by the Apache-2.0 license.