GITHUB_WIKI_README

GitHub Wiki 推送指南

本目录包含 REX 项目的 Wiki 文档，可以推送到 GitHub Wiki。

文件列表

文件名	内容
Home.md	项目首页（原 README.md）
architecture.md	系统架构文档
concepts.md	核心概念说明
deployment.md	安装部署指南
getting-started.md	快速开始教程
workspace.md	工作空间功能
terminal.md	SSH 终端功能
sql-console.md	SQL 控制台功能
redis-console.md	Redis 控制台功能
file-manager.md	文件管理功能
api-reference.md	REST API 参考
data-models.md	数据模型说明
frontend-architecture.md	前端架构文档
keyboard-shortcuts.md	快捷键说明
development.md	开发者文档
contributing.md	贡献指南

推送到 GitHub Wiki

前置条件

1. GitHub 账号访问：需要有 JeeLin/REX 仓库的写入权限
2. SSH 密钥配置：确保本地 SSH 密钥已添加到 GitHub 账号

步骤 1：初始化 GitHub Wiki

1. 访问 https://github.com/JeeLin/REX/wiki
2. 点击 "Create the first page"
3. 输入任意内容（例如 "REX Wiki"）
4. 点击 "Save Page"

步骤 2：推送文档

运行推送脚本：

/tmp/push-to-ggithub-wiki.sh

脚本会自动：

• 复制所有 Wiki 文件
• 初始化 Git 仓库
• 提交并推送到 GitHub Wiki

步骤 3：验证

推送完成后，访问 https://github.com/JeeLin/REX/wiki 查看文档。

文件格式说明

所有文档都遵循以下格式：

• 使用 Markdown 语法
• 支持 GitHub Wiki 特有的语法（如 [[链接]]）
• 每个文件都是独立的 Wiki 页面
• Home.md 是 Wiki 的首页

本地预览

可以在本地使用 Markdown 编辑器预览文档，或者使用：

# 使用 grip 预览
pip install grip
grip wiki/GITHUB_WIKI_README.md

# 或者使用 VS Code
code wiki/GITHUB_WIKI_README.md

更新文档

如果需要更新 Wiki 文档：

1. 编辑 /paperclip/work/REX/wiki/ 目录下的对应文件
2. 运行推送脚本更新 GitHub Wiki
3. Git 会自动处理增量更新

故障排除

推送失败

如果推送失败，请检查：

1. SSH 连接：ssh -T git@github.com
2. Wiki 是否已初始化：确保已按照步骤 1 创建了 Wiki 页面
3. 权限问题：确保有仓库的写入权限

常见错误

• Repository not found：Wiki 仓库未创建，请先初始化
• Permission denied：SSH 密钥未配置或权限不足
• Could not read from remote repository：网络问题或 SSH 连接失败

相关链接

• REX GitHub 仓库
• REX Wiki
• REX 文档