Skip to content

docs: reposition around "Link" and build complete Mintlify docs system#197

Merged
shuxueshuxue merged 8 commits intomainfrom
docs/polish
Apr 4, 2026
Merged

docs: reposition around "Link" and build complete Mintlify docs system#197
shuxueshuxue merged 8 commits intomainfrom
docs/polish

Conversation

@nmhjklnm
Copy link
Copy Markdown
Collaborator

@nmhjklnm nmhjklnm commented Apr 4, 2026

Summary

  • README (EN+ZH): Rewrite tagline and intro to reflect the "Link" positioning (body/mind/memory/social) — replaces the previous "enterprise agent runtime" framing
  • Mintlify docs system: Complete rebuild of /docs for Mintlify deployment
    • docs.json with EN/ZH tab navigation, group icons, and global anchors
    • 9 pages per language (18 total .mdx files), including 3 new pages not in the original docs: quickstart, concepts, memory
    • Replaced 12 legacy .md files and removed internal marketplace-architecture.md
  • Rich Mintlify components throughout: Mermaid diagrams (flowcharts + sequence diagrams), AccordionGroup, Tree, Tabs, CodeGroup, Steps, Columns, CardGroup
  • Frontmatter: icon, sidebarTitle, keywords on every page; introduction uses mode: wide

Test plan

  • Mintlify deployment auto-triggers on merge to main (configured in dashboard: org=opendcai, repo=Mycel, branch=main, path=/docs)
  • Verify EN tab: all 9 pages render correctly
  • Verify ZH tab: all 9 pages render correctly
  • Mermaid diagrams render (introduction, concepts, multi-agent-chat, sandbox, memory)
  • mode: wide applies to introduction pages
  • Global anchors (GitHub, Community) appear in sidebar

…cs system

- Rewrite README (EN+ZH): tagline and intro now reflect "Link" positioning
  (body/mind/memory/social) instead of "enterprise agent runtime"
- Add docs/docs.json: Mintlify config with EN/ZH tabs, group icons, global anchors
- Replace 6 legacy .md docs with 9 new .mdx pages per language (18 total):
  introduction, quickstart, concepts, multi-agent-chat, sandbox, memory,
  configuration, cli, deployment
- New pages: quickstart.mdx, concepts.mdx, memory.mdx (not in original docs)
- All pages use Mintlify components: Mermaid diagrams, AccordionGroup,
  Tree, Tabs, CodeGroup, Steps, Columns, CardGroup
- Frontmatter: icon, sidebarTitle, keywords on every page
- introduction uses mode: wide
@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 4, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
nextmind-85153aa2 🟢 Ready View Preview Apr 4, 2026, 10:42 AM

nmhjklnm added 3 commits April 4, 2026 06:49
- docs.json: move anchors from global.anchors to top-level anchors field
- cli.mdx: restore missing sandbox delete and destroy-all-sessions commands (EN+ZH)
- configuration.mdx: restore merge strategy table for all config domains (EN+ZH)
- deployment.mdx: restore Daytona self-hosted section with Docker Compose
  network config, /etc/hosts setup, and expanded troubleshooting accordion (EN+ZH)
- Delete docs/en/cli.mdx and docs/zh/cli.mdx entirely
- Remove cli from docs.json navigation (EN+ZH)
- sandbox.mdx: remove CLI commands section, keep API endpoints only
- configuration.mdx: replace leonai config wizard with manual file creation;
  replace leonai --model with models.json example
- concepts.mdx: replace leonai thread rewind with generic API description
- memory.mdx: remove leonai thread rewind reference
- deployment.mdx: remove leonai config and leonai --version/sandbox commands
- anchors -> global.anchors: global.anchors are persistent sidebar links,
  plain anchors is a different nav pattern (replaces tabs)
- Replace languages (FA Pro) with globe (FA Free)
- Replace layers (FA Pro) with book-open (FA Free)
- Replace sliders with gear (FA Free)
@shuxueshuxue
Copy link
Copy Markdown
Collaborator

@f-2j review this again

Copy link
Copy Markdown
Collaborator

@f-2j f-2j left a comment

Choose a reason for hiding this comment

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

Findings (blocking):

  1. Broken README doc links after .md -> .mdx migration.
  • README.md:62,173-178 links to removed files: docs/en/sandbox.md, docs/en/cli.md, docs/en/configuration.md, docs/en/multi-agent-chat.md, docs/en/deployment.md, docs/en/product-primitives.md.
  • README.zh.md:62,173-178 has the same issue for docs/zh/*.

I verified this on PR head (docs/polish) by checking actual file existence; those paths do not exist.

Impact: users following README hit 404s from the project landing page.

Requested fix:

  • Update README links to existing docs targets (*.mdx or valid new paths).
  • Replace product-primitives with concepts.
  • Either restore CLI docs or remove the CLI entries from both READMEs.

f-2j
f-2j previously requested changes Apr 4, 2026
Copy link
Copy Markdown
Collaborator

@f-2j f-2j left a comment

Choose a reason for hiding this comment

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

Re-review result: one blocking regression remains.

The PR migrates docs pages to .mdx, but both top-level READMEs still link to deleted .md files, so these links 404 on GitHub.

Evidence on current PR head (39b5c52):

  • README.md:62,173-178 links to docs/en/*.md (missing)
  • README.zh.md:62,173-178 links to docs/zh/*.md (missing)
  • repository tree contains docs/en/*.mdx and docs/zh/*.mdx for those pages

Please update those links to existing targets (or to Mintlify-hosted URLs) and I will re-review quickly.

@nmhjklnm
Copy link
Copy Markdown
Collaborator Author

nmhjklnm commented Apr 4, 2026

Fixed: updated all README doc links from deleted .md files to the new .mdx paths, removed the CLI entry (CLI was removed from the project), and replaced product-primitives with concepts. Commit: 347bdd1

@OpenDCAI OpenDCAI deleted a comment from f-2j Apr 4, 2026
@shuxueshuxue shuxueshuxue merged commit cd714d2 into main Apr 4, 2026
6 checks passed
@OpenDCAI OpenDCAI deleted a comment from f-2j Apr 4, 2026
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.

3 participants