Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nexfi.robert.dpdns.org/llms.txt

Use this file to discover all available pages before exploring further.

​
Local Development

​
Prerequisites

  • Node.js installed
  • mintlify/ directory available locally

​
Start local preview

From the mintlify/ directory: 
mint dev
If the CLI is not installed globally: 
npx mint dev
Default preview address: 
http://localhost:3000

​
Useful preview options

Use a custom port: 
mint dev --port 3333
Prevent the browser from auto-opening: 
mint dev --no-open

​
File layout

Main configuration: 
mintlify/docs.json
Guide pages: 
mintlify/wallet/
mintlify/bridge/
mintlify/staking/
mintlify/quant/
mintlify/zh/wallet/
mintlify/zh/bridge/
mintlify/zh/staking/
mintlify/zh/quant/
OpenAPI contracts: 
mintlify/openapi/
mintlify/openapi/zh/

​
Maintenance rules

When adding or changing an API, update these layers together:
  1. OpenAPI file Update schema, field descriptions, examples, request bodies, and responses.
  2. MDX guide page Update endpoint purpose, parameter tables, response field tables, and business notes.
  3. Navigation when needed If a page is added, renamed, or regrouped, update mintlify/docs.json.

​
Bilingual maintenance rules

This site does not reuse one language for the other.
  • English and Chinese MDX pages are maintained separately.
  • English and Chinese OpenAPI files are also maintained separately.
When changing one module, check all four assets where applicable:
  • English guide page
  • Chinese guide page
  • English OpenAPI file
  • Chinese OpenAPI file
For example, if Wallet assets APIs change: 
mintlify/wallet/config-assets.mdx
mintlify/zh/wallet/config-assets.mdx
mintlify/openapi/wallet.openapi.yaml
mintlify/openapi/zh/wallet.openapi.yaml
  1. Add or update the endpoint in the module OpenAPI file.
  2. Add field descriptions and examples immediately.
  3. Update the corresponding MDX guide page in English.
  4. Update the corresponding MDX guide page in Chinese.
  5. Update the Chinese OpenAPI file if the Chinese API Reference should render localized descriptions.
  6. Run local preview and spot-check both languages.

​
Official references