Skip to content

Latest commit

 

History

History
72 lines (46 loc) · 2 KB

File metadata and controls

72 lines (46 loc) · 2 KB

ImageFox 文档

本目录包含所有项目文档,按语言组织。

目录结构

  • zh-CN/ - 中文(简体)文档
  • en-US/ - 英文文档

文档命名约定

所有文档遵循命名模式:{文档名称}_{语言代码}.md

例如:

  • api-design_zh-CN.md - API 设计(中文)
  • api-design_en-US.md - API 设计(英文)

可用文档

核心文档

  • 项目概述 (project-overview_{语言代码}.md)

    • 产品介绍、核心功能、技术优势、用户场景
  • API 设计 (api-design_{语言代码}.md)

    • 完整的 API 规范,包括认证、仓库管理、包管理、NuGet 协议接口
  • 数据库设计 (db-design_{语言代码}.md)

    • 数据库架构设计、表结构、关系、索引策略
  • 功能路线图 (roadmap_{语言代码}.md)

    • 功能路线图、实现状态、技术栈详情

开发指南

  • 后端开发指南 (backend-dev-guidelines_{语言代码}.md)

    • 后端架构、编码规范、测试策略
  • 前端开发指南 (frontend-dev-guidelines_{语言代码}.md)

    • 前端架构、项目结构、编码规范、国际化策略
  • 测试指南 (testing-guide_{语言代码}.md)

    • 测试策略、覆盖率计划、测试实施指南

参考文档

  • 错误码 (error-codes_{语言代码}.md)

    • 完整的错误码定义和使用说明
  • HTTP 代理配置 (http-proxy-configuration_{语言代码}.md)

    • HTTP 代理配置指南
  • 系统设置常量 (system-setting-constants_{语言代码}.md)

    • 系统设置键常量及描述

语言支持

当前支持的语言:

  • zh-CN(简体中文)
  • en-US(英文)

文档状态

重要说明:所有文档中的功能均处于计划中状态,尚未实现。文档创建日期:2025年12月23日。

贡献

添加或更新文档时:

  1. 如果适用,请更新两种语言版本
  2. 遵循命名约定:{名称}_{语言代码}.md
  3. 如果添加新文档,请更新此 README
  4. 保持内部链接相对且语言感知