Skip to content

Replace Mintlify with Fumadocs - #24

Merged
hudsonaikins merged 4 commits into
mainfrom
codex/neural-fumadocs-migration
Jul 28, 2026
Merged

Replace Mintlify with Fumadocs#24
hudsonaikins merged 4 commits into
mainfrom
codex/neural-fumadocs-migration

Conversation

@hudsonaikins

@hudsonaikins hudsonaikins commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Problem

Neural documentation depends on Mintlify configuration and automation that no longer matches the selected documentation platform.

Outcome

  • add a repository-owned Fumadocs/Next.js site in docs-site/
  • keep docs/ as the single authoritative content source
  • provide generated navigation, search, responsive layouts, and a Neural visual shell
  • replace Mintlify CI with locked Fumadocs typecheck and production-build validation
  • remove Mintlify-only workflows, configuration, dependencies, and stale automation plan
  • keep deployment, hosting, and DNS outside this PR

Acceptance Criteria

  • all documentation pages compile through Fumadocs
  • /docs, Getting Started, Data Collection, and Trading Quickstart render on desktop and mobile
  • search and mobile navigation work
  • no Mintlify references remain in the candidate
  • documentation and example validators pass
  • full Python regression suite passes
  • Fumadocs dependencies install from the committed lockfile in a fresh worktree
  • all review threads addressed and resolved

Validation

Exact head: 818263c3cf5daa2cb05f3324636638606872dee8

  • uv lock --check
  • uv sync --extra dev --dry-run
  • uv run python scripts/validate_docs.py
  • uv run python scripts/validate_examples.py
  • uv run ruff check .
  • uv run pytest -q — 111 passed, 6 skipped
  • bun install --frozen-lockfile
  • bun run typecheck
  • bun run build — 41 generated routes
  • Playwright desktop/mobile route, search, sidebar, console, and overflow checks

Residual Risk

Existing documentation coverage and example-quality warnings remain advisory and predate this migration. Hosting selection, production deployment, DNS, and live monitoring require separate approval.

Plane mapping: none identified; no work-item identifier invented.

@hudsonaikins
hudsonaikins marked this pull request as ready for review July 28, 2026 17:04
@github-actions

Copy link
Copy Markdown

📚 Documentation Status

✅ Documentation changes detected

  • Documentation structure validated
  • Links checked for broken references
    ✅ README changes detected

This comment is automatically generated by the documentation workflow.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 26cb60bd04

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread .github/workflows/docs.yml
Comment thread scripts/validate_docs.py
Comment thread docs-site/app/docs/layout.tsx
Comment thread pyproject.toml
Comment thread README.md Outdated
Comment thread docs-site/app/global.css
@hudsonaikins
hudsonaikins merged commit bebd353 into main Jul 28, 2026
9 checks passed
@hudsonaikins
hudsonaikins deleted the codex/neural-fumadocs-migration branch July 28, 2026 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant