Skip to main content

Mintlify 文档自动化项目 - 上下文存档

存档时间: 2026-01-22 项目路径: /tmp/mintlify-docs-main 本地预览地址: http://localhost:3000

项目概述

这是一个基于 Mintlify 的文档自动化项目,为 Readdy(AI 网站构建工具)创建集成文档。 当前任务:为 Resend 邮件服务集成 编写帮助文档。

当前工作状态

✅ 已完成的工作

  1. 创建了 Resend 集成文档
    • 文件路径:/tmp/mintlify-docs-main/integrations/resend.mdx
    • 已添加到导航菜单(在 docs.json 中)
    • 文档位置:Integrations 分组,位于 Supabase 之后,Shopify 之前
  2. 文档结构(4个主要部分)
    • 第1节:基础配置(注册、连接 Supabase、获取 API Key)
    • 第2节:测试和验证(测试邮件 + 数据库验证 = 流程闭环)
    • 第3节:品牌化设置(可选 - 购买域名、DNS 验证)
    • 第4节:高级功能(可选 - AI Agent、日历预约)
  3. 本地预览服务器
    • 启动命令:cd /tmp/mintlify-docs-main && npx mint dev
    • 访问地址:http://localhost:3000
    • 后台进程 ID:bb42076(可能已停止,需重新启动)

文档风格参考

项目位于:/Users/shikexin/Downloads/mintlify-docs-main.zip

Mintlify 组件使用规范

代码…

Resend 文档内容大纲

文件:integrations/resend.mdx


待完成的任务

📋 必需任务

  1. 准备图片资源
    • 需要的截图列表(当前都使用了占位路径):
      • /images/resend-signup.png - Resend 注册页面
      • /images/resend-api-key.png - API Key 创建界面
      • /images/resend-integration-entry.png - 集成入口
      • /images/resend-connect-api.png - 连接 API 界面
      • /images/resend-test-booking.png - 测试预约表单
      • /images/resend-email-received.png - 收到确认邮件
      • /images/resend-supabase-records.png - Supabase 数据库记录
      • /images/resend-add-domain.png - 添加域名
      • /images/resend-dns-records.png - DNS 记录
      • /images/resend-verify-domain.png - 验证域名
      • /images/resend-logs.png - Resend 日志
    操作:将截图放入 /tmp/mintlify-docs-main/images/ 目录
  2. 测试文档预览
    • 确保所有链接可点击
    • 验证组件正确渲染
    • 检查移动端显示效果

🔄 可选优化

  1. 内容精简
    • 根据实际需求调整内容详细程度
    • 添加更具体的示例
  2. 样式调整
    • 优化表格显示
    • 调整图片大小和说明
  3. SEO 优化
    • 检查 meta description
    • 添加关键词

重要配置文件

docs.json 配置


下次工作指南

如何继续工作

  1. 打开项目
  2. 启动预览服务器
  3. 访问预览
  4. 在 Cursor 中编辑
    • 使用 Cursor 打开整个 /tmp/mintlify-docs-main 目录
    • 编辑 integrations/resend.mdx 文件
    • 保存后浏览器会自动刷新

给 AI 的提示

如果下次需要继续编辑这个文档,请这样告诉 AI:

项目文件结构


相关文档参考

优秀的集成文档示例

  1. Stripe 集成 (integrations/stripe.mdx)
    • 详细的步骤说明
    • 清晰的权限表格
    • 完整的注意事项
  2. Calendly 集成 (integrations/calendly.mdx)
    • 简洁的步骤
    • 丰富的图片演示
    • 清晰的操作流程
  3. Supabase 集成 (integrations/supabase.mdx)
    • 复杂集成的完整示例
    • 多个功能模块

技术栈

  • 文档框架: Mintlify
  • 格式: MDX (Markdown + JSX)
  • 本地预览: npx mint dev
  • 配置文件: docs.json

联系方式与支持


快速命令参考


最后更新

  • 日期: 2026-01-22
  • 状态: Resend 文档初稿已完成,等待图片资源和测试
  • 下一步: 准备截图,完善视觉内容

此文件用于在 Cursor 中打开,以便 AI 读取上下文并继续工作