Skip to content
This repository was archived by the owner on Jul 14, 2026. It is now read-only.

README.md

Latest commit

 

History

History
53 lines (38 loc) · 1.99 KB

README.md

File metadata and controls

53 lines (38 loc) · 1.99 KB
Raw

Thread Docs (Mintlify)

The Thread help center migrated from HelpDocs (docs.getthread.com) into Mintlify.

Preview locally

npm i -g mint        # Mintlify CLI
mint dev             # serves the site at http://localhost:3000

docs.json holds the navigation and theme. Each article is an .mdx file under a section folder (get-started/, inbox/, ai-agents/, …).

Re-running the migration

Everything is regenerated by one script. It reads the HelpDocs read API key from the environment (never committed) and rewrites the docs tree, docs.json, and images/.

export HELPDOCS_API_KEY=your_read_api_key
python3 scripts/migrate.py        # full run: pulls all articles + downloads images

Scope migrated: every published article, plus private articles created or updated since 2026-04-27. Drafts and older private articles are skipped. The scope rule lives in SCOPE_CUTOFF / in_scope() in scripts/migrate.py.

Images only ("images later")

The first pass through this environment couldn't download binaries, so image links already point at local /images/... paths and the URL→path map is saved in scripts/image-manifest.json. To pull the binaries without touching the text:

python3 scripts/fetch_assets.py   # downloads all 385 referenced images into images/

A full migrate.py run also downloads images, so you only need fetch_assets.py if you want the assets without re-pulling article text.

What's here

  • docs.json — navigation + theme (13 top-level sections)
  • */*.mdx — 151 articles
  • scripts/migrate.py — HelpDocs → Mintlify converter (HTML→MDX, nav, images)
  • scripts/fetch_assets.py — standalone image downloader
  • scripts/image-manifest.json — image URL → local path map
  • MIGRATION-NOTES.md — scope, IA mapping, and the list of pages awaiting a live re-run

See MIGRATION-NOTES.md for details, including the 15 pages that are currently placeholders and fill in automatically on the next migrate.py run.