Skip to content

docs: complete documentation rewrite with 25+ new pages and LLM-friendly files#37

Merged
Innei merged 4 commits intomainfrom
docs/rewrite-complete
May 4, 2026
Merged

docs: complete documentation rewrite with 25+ new pages and LLM-friendly files#37
Innei merged 4 commits intomainfrom
docs/rewrite-complete

Conversation

@Innei
Copy link
Copy Markdown
Member

@Innei Innei commented May 4, 2026

Summary

Complete rewrite and expansion of the Mix Space documentation site.

New Structure (8 sections)

Section Pages What's Covered
Getting Started 3 What is Mix Space, prerequisites, 5-min quick start
Deploy 7 Docker, one-script, source, reverse proxy, SSL, external DB, community guides
Configure 8 Environment vars, SEO, OAuth, Algolia, encryption, account/security, image storage
Themes 9 Yohaku, Shiro, Kami, Yun, community themes
Use 17 Writing, content, comments, friends, says, projects, files, analytics, AI features, webhook, mail, serverless, cron tasks, backup, update, FAQ
Migrate 3 v11 to v12 (MongoDB to PostgreSQL), WordPress migration
Develop 5 Backend, frontend, admin, contributing
Reference 2 Common issues, speed reference

New Pages (14)

content, comments, friends, says, projects, files, webhook, mail-subscribe, analytics, cron-tasks, seo, account-security, image-storage

Rewritten Pages (7)

serverless (45 to 120 lines), oauth, faq, ssl, from-wordpress, develop/index, quick-start

LLM-Friendly Files

File Size Purpose
/llm.txt 4.3 KB Concise project overview for LLMs
/llm-full.txt 180 KB Complete documentation as plain text
/agent-skills/mix-space-expert.md 3.8 KB Agent skill: deployment, config, troubleshooting
/agent-skills/mix-space-development.md 6.0 KB Agent skill: codebase, patterns, commands
/robots.txt 163 B Crawler discovery for LLM files

Other Changes

  • Updated AGENTS.md to reflect PostgreSQL (was MongoDB)
  • Updated getting-started/what-you-need.mdx with correct system architecture
  • All pages build successfully (61 static pages)

Stats

  • 87 files changed, +8,597 / -1,395 lines
  • Total doc pages: 36 to 61 (+25)

…dly files

- Restructure docs into 8 sections: getting-started, deploy, configure, themes, use, migrate, develop, reference
- Add 14 new pages: content management, comments, friends, says, projects, files, webhook, mail-subscribe, analytics, cron-tasks, SEO, account-security, image-storage
- Rewrite 7 existing pages with expanded content: serverless, oauth, faq, ssl, from-wordpress, develop/index, quick-start
- Add LLM-friendly files: llm.txt (4KB summary), llm-full.txt (180KB full docs), 2 agent skills
- Add robots.txt for LLM crawler discovery
- Update AGENTS.md to reflect PostgreSQL (v12 migration)
- All 61 pages build successfully
@safedep
Copy link
Copy Markdown

safedep Bot commented May 4, 2026

SafeDep Report Summary

Green Malicious Packages Badge Green Vulnerable Packages Badge Green Risky License Badge

Package Details
Package Malware Vulnerability Risky License Report
icon typescript @ 6.0.3
pnpm-lock.yaml
ok icon
ok icon
ok icon
🔗

View complete scan results →

This report is generated by SafeDep Github App

Innei added 3 commits May 4, 2026 21:20
…erence

- Add deploy/agent.mdx: AI Agent deployment guide (Claude Code, Codex, etc.)
- Restructure use/index.mdx: group 17 pages into 5 sections with headers
  (内容管理, AI 功能, 扩展与集成, 系统管理, 常见问题)
- Update deploy/index.mdx: add Agent deploy as first option for beginners
- Fix getting-started/index.mdx: remove MongoDB reference (now PostgreSQL only)
- Reorder use/meta.json: content first, then AI, extensions, system
- Add 27 redirect rules in next.config.mjs for dev mode
- Add 27 static HTML files in public/docs/ for production (output: export)
- Covers all old paths: /docs/core/*, /docs/usage/*, /docs/development/*,
  /docs/document/*, and common short paths like /docs/quick-start
- All redirects verified returning 200 in both dev and production builds
…rkdown links

Relative ./ links in section index pages resolved incorrectly because
the page URL has no trailing slash (e.g. /docs/deploy resolves ./agent
to /docs/agent instead of /docs/deploy/agent).

Changes:
- Replace all href="./xxx" with href="/docs/section/xxx" in Card components
- Replace all [text](./xxx) with [text](/docs/section/xxx) in markdown links
- Remove short-path redirects from next.config.mjs (no longer needed)
- Remove corresponding static HTML redirect files

Affected files:
- configure/index.mdx (7 Cards + 7 markdown links)
- deploy/index.mdx (4 Cards + 6 markdown links)
- deploy/docker.mdx (1 Card)
- deploy/source.mdx (2 markdown links)
- getting-started/index.mdx (2 Cards)
- getting-started/what-you-need.mdx (1 markdown link)
- themes/shiro/deploy.mdx (1 markdown link)
@Innei Innei merged commit 068e329 into main May 4, 2026
3 checks passed
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