Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.wrld.tech/llms.txt

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

This site is built with Mintlify and deployed from the WRLDInc/docs repository. Content is authored in MDX, and navigation is configured in docs.json.
Prerequisites:
  • Node.js LTS (Node 22 recommended — Mintlify does not support Node 25+). See Conda for Node.js if you need to isolate Node versions per project.
  • A docs repository with a docs.json file

​
Preview locally

1

Install the Mintlify CLI

npm i -g mint
2

Run the dev server

From the repo root (where docs.json lives):
mint dev
Open http://localhost:3000. Pages hot-reload as you edit .mdx files.
3

Validate links

Before opening a PR:
mint broken-links
Use mint dev --port 3333 to change the port, and mint update to upgrade the CLI.

​
Add a new page

  1. Create an .mdx file under the relevant section directory (for example wrld-host/new-feature.mdx).
  2. Add YAML frontmatter: 
    ---
title: "Page title"
description: "One-line summary shown in nav and search."
---
  3. Register the page path (without .mdx) in the appropriate group inside docs.json: 
    {
  "group": "Hosting",
  "pages": [
    "wrld-host/overview",
    "wrld-host/new-feature"
  ]
}
  4. Reload mint dev and confirm the page appears in the navigation.
  5. Run mint broken-links and open a pull request.

​
Repository layout

See the layout table in README.md. Each top-level directory maps to a tab or group in docs.json.

​
Content conventions

  • Voice: first-person plural (“we”) for WRLD, second-person (“you”) for the reader.
  • Headings: use ## for primary sections — the title frontmatter already renders h1.
  • Links: prefer site-relative links (/support/overview) for internal pages. External links are always absolute URLs.
  • Brand tokens: do not hard-code colors or fonts in pages. Reference Design or Brand Guide and update those pages if the brand changes upstream.
  • Source of truth: WRLD service names, URLs, colors, and typography are mirrored from WRLDInc/wrld.one. Update there first if a brand token changes.

​
Deployment

Merges to the default branch auto-deploy via Mintlify’s GitHub integration. There is no separate CI build step.

​
Troubleshooting

Usually an outdated Node version. Remove the CLI (npm remove -g mint), upgrade to Node 19+, then reinstall (npm i -g mint).
Confirm the file path in docs.json matches the .mdx filename (no extension, no leading slash) and that mint dev is running from the directory containing docs.json.
Delete ~/.mintlify and re-run mint dev.