简化 Debian 发布流程并添加项目文档系统
All checks were successful
Build and Release / build-and-test (arm64, alpine) (push) Successful in -13s
Build and Release / build-and-test (amd64, alpine) (push) Successful in -6s
Build and Release / build-and-test (arm64, ubuntu) (push) Successful in -7s
Build and Release / build-and-test (amd64, ubuntu) (push) Successful in 7s
Build and Release / release (push) Successful in 21s

- 将 Debian 包仓库从 bookworm/trixie 双发行版改为通用 stable 仓库
- 新增完整的 llmdoc 文档系统,包含架构、指南和参考文档
- 更新 README.md 和部署指南以反映新的仓库配置
- 添加 .gitignore 文件
This commit is contained in:
2025-12-25 10:18:07 +08:00
parent 76aac67b71
commit 9afe4a8649
28 changed files with 1297 additions and 31 deletions

68
llmdoc/index.md Normal file
View File

@@ -0,0 +1,68 @@
# XXXigCC Proxy 项目文档
> XXXigCC Proxy 是一个基于 XMRigCC Proxy 的修改版本,专注于禁用捐赠功能,提供多架构、多发行版支持的挖矿代理服务。
## 📖 项目概览
- [项目概述](overview/project-overview.md) - 项目简介、核心特性和背景
## 🏗️ 架构文档
### 源代码修改
- [源代码修改架构](architecture/source-code-modification.md) - init.sh 脚本的工作原理和修改策略
### 构建系统
- [Docker 构建系统](architecture/docker-build-system.md) - Docker BuildX 多架构构建系统
- [多架构构建策略](architecture/multi-arch-strategy.md) - amd64/arm64 架构支持的实现细节
### CI/CD 发布
- [CI/CD 流水线架构](architecture/cicd-pipeline.md) - Gitea Actions 自动化构建和发布流程
- [发布流程架构](architecture/release-process.md) - Generic 和 Debian Package Registry 的使用
### Debian 打包
- [Debian 包构建架构](architecture/debian-packaging.md) - Debian 包的构建流程和结构
- [Systemd 服务配置架构](architecture/systemd-service.md) - 服务配置、安全设置和资源限制
### 部署
- [部署架构](architecture/deployment-architecture.md) - 系统部署架构和配置管理
## 📚 操作指南
### 源代码修改
- [如何修改源代码](guides/how-to-modify-source-code.md) - 修改 XMRigCC 源代码的详细步骤
### Docker 构建
- [如何构建 Docker 镜像](guides/how-to-build-docker-images.md) - 本地构建多架构 Docker 镜像
- [Docker 构建问题排查](guides/troubleshooting-docker-builds.md) - 常见构建错误和解决方案
### CI/CD 管理
- [如何触发 Release](guides/how-to-trigger-release.md) - 创建新版本和发布的步骤
- [如何修改 CI/CD 工作流](guides/how-to-modify-cicd-workflow.md) - 修改 Gitea Actions 工作流
### Debian 打包
- [如何构建 Debian 包](guides/how-to-build-debian-package.md) - 本地构建 Debian 软件包
- [如何修改 Systemd 服务](guides/how-to-modify-systemd-service.md) - 调整服务配置和安全设置
### 部署和配置
- [部署指南](guides/how-to-deploy.md) - Debian 仓库、二进制包和 Docker 部署方式
- [配置指南](guides/how-to-configure.md) - 配置文件说明和最佳实践
## 📋 参考文档
### 开发规范
- [Shell 脚本编码规范](reference/coding-conventions.md) - Shell 脚本的编码标准和最佳实践
- [Git 规范指南](reference/git-conventions.md) - 提交信息、分支管理和标签规范
### 技术参考
- [源代码修改清单](reference/modification-checklist.md) - 所有修改点的清单和验证步骤
- [Debian 包结构详解](reference/debian-package-structure.md) - Debian 包的目录结构和文件说明
- [配置选项参考](reference/configuration-options.md) - 所有配置选项的详细说明
## 🔗 其他资源
- [许可证](../LICENSE) - GPL-3.0 开源许可证
- [原始项目](https://github.com/Bendr0id/XMRigcc-Proxy) - XMRigCC Proxy 源项目
## ⚠️ 免责声明
本项目**仅供学习和研究使用**。用户需严格遵守当地法律法规,任何非法使用均与项目作者无关。