mirror of https://github.com/luongnv89/claude-howto.git synced 2026-07-11 23:26:32 +02:00

Files

T

Luong NGUYEN 89e89d4aa3 feat(zh): add Chinese translations in zh/ directory

Add Chinese (Simplified) translations for all documentation, organized
under a dedicated zh/ directory that mirrors the English folder structure.

Co-authored-by: tanqingkuang <tanqingkuang@users.noreply.github.com>

Translations originally contributed by @tanqingkuang in #45.
Restructured from *-CN.md suffix pattern into zh/ directory to prevent
the EPUB builder (scripts/build_epub.py collect_folder_files) from
picking up Chinese files via glob("*.md") inside module folders.

2026-04-06 23:08:54 +02:00

1.2 KiB

Raw Blame History

name, description, tags

name	description	tags
文档重构	为项目重新组织文档结构，以提升清晰度和可访问性	documentation, refactoring, organization

文档重构

根据项目类型重构项目文档结构：

分析项目：识别类型（库/API/Web 应用/CLI/微服务）、架构和用户角色
集中管理文档：将技术文档迁移到 docs/，并保留正确的交叉引用
整理根目录 README.md：将其精简为入口页，包含概览、快速开始、模块/组件摘要、许可证和联系方式
为组件补充文档：添加模块/包/服务级别的 README 文件，包含安装和测试说明
按主题组织 docs/：
- 架构、API Reference、数据库、设计、故障排查、部署、贡献（根据项目需要调整）
创建指南（按需选择）：
- 用户指南：面向应用最终用户的文档
- API 文档：API 的端点、认证和示例
- 开发指南：环境搭建、测试、贡献流程
- 部署指南：服务/应用的生产部署
所有图表都使用 Mermaid（架构图、流程图、Schema 图）

保持文档简洁、易扫读，并与项目类型保持上下文一致。

1.2 KiB Raw Blame History Unescape Escape

文档重构

1.2 KiB

Raw Blame History