Skip to content

Commit ca25844

Browse files
author
shijiashuai
committed
docs: professional documentation refactor & i18n support
docs: 专业文档重构与国际化支持 - 重构 docs/ 目录结构,支持中英文双语 - 中文文档迁移至 docs/zh/ - 新增完整英文文档 docs/en/ - 新增 API 参考文档 - 完善 CHANGELOG 采用 Keep a Changelog 标准 - 添加英文版 CHANGELOG.md - 添加中文版 CHANGELOG.zh-CN.md - 优化 README.md 专业性和可读性 - 添加双语切换导航 - 优化文档结构 - 完善徽章和统计信息 - 新增诊断脚本和故障排除工具 BREAKING CHANGE: 文档路径结构调整 - 旧文档路径自动兼容 - 新路径:docs/zh/ 和 docs/en/
1 parent f8bccf9 commit ca25844

19 files changed

+4494
-1290
lines changed

CHANGELOG.md

Lines changed: 190 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -1,160 +1,252 @@
1-
# 更新日志
1+
# Changelog
22

3-
所有重要变更都会记录在此文件中。
3+
All notable changes to this project will be documented in this file.
44

5-
格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)
6-
版本号遵循 [语义化版本](https://semver.org/lang/zh-CN/)
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
---
8+
## [Unreleased]
99

10-
## [2.0.0] - 2025-01-16
10+
## [2.1.0] - 2025-04-16
1111

12-
### 新增
12+
### 🎉 Highlights
1313

14-
- **29 个新规则文件**
14+
- **Bilingual Documentation**: Complete Chinese and English documentation support
15+
- **Professional Refactor**: Restructured docs with improved navigation and clarity
16+
- **New API Reference**: Added comprehensive rules format reference guide
1517

16-
- React 生态:apollo-graphql, mobx, nextjs-14-seo, nextjs-react-ts, nextjs-supabase, nextjs-ui, react-components, react-typescript, styled-components
17-
- 后端规则:Go, Java, Django, NestJS, express-mongodb
18-
- 其他:Convex, DragonRuby, Elixir, GitHub 代码质量, 代码规范, TypeScript axios/conventions/vite-tailwind
18+
### 📚 Documentation
1919

20-
- **全新文档体系**
20+
#### Added
21+
- Full English documentation set in `docs/en/`
22+
- README.md - Documentation home
23+
- getting-started.md - Quick start guide
24+
- installation-guide.md - Complete setup instructions
25+
- best-practices.md - Rules usage best practices
26+
- troubleshooting.md - Comprehensive troubleshooting guide
27+
- api-reference.md - Rules file format reference
28+
- Chinese documentation restructured in `docs/zh/`
29+
- All documents professionally rewritten
30+
- Improved structure and navigation
31+
- Added cross-references between documents
32+
- New `docs/assets/` directory for shared resources
2133

22-
- 重写 `docs/getting-started.md` - 三步快速上手指南
23-
- 重写 `docs/best-practices.md` - 完整最佳实践手册
24-
- 重写 `docs/installation-guide.md` - 多平台安装配置
25-
- 重写 `docs/troubleshooting.md` - 故障排除工具箱
26-
- 重写 `CONTRIBUTING.md` - 贡献指南和术语表
27-
- 重写 `README.md` - 精简项目主页
34+
#### Changed
35+
- Moved original docs to `docs/zh/` directory
36+
- Enhanced documentation with better formatting and examples
37+
- Added quick navigation and cross-links
38+
- Improved troubleshooting section with diagnostic scripts
2839

29-
### 修复
40+
### 🔧 Infrastructure
3041

31-
- 移除重复目录 `rules/frontend/mobile/`
32-
- 合并重复 Flutter 规则目录
33-
- 修复文档中的无效路径引用
34-
- 补充缺失的 `.cursorrules` 文件
42+
#### Added
43+
- Bilingual navigation in all documentation
44+
- Language switcher badges
45+
- Improved documentation templates
3546

36-
### 变更
47+
---
48+
49+
## [2.0.0] - 2025-01-16
3750

38-
- 更新项目统计数据:119 个规则文件、43 个技术领域、568 个文档
39-
- 统一规则文件格式和风格
40-
- 优化目录结构组织
51+
### ✨ Features
52+
53+
#### New Rules (29 files)
54+
55+
**React Ecosystem**
56+
- `apollo-graphql` - Apollo GraphQL integration
57+
- `mobx` - MobX state management
58+
- `nextjs-14-seo` - Next.js 14 SEO optimization
59+
- `nextjs-react-ts` - Next.js React TypeScript
60+
- `nextjs-supabase` - Next.js with Supabase
61+
- `nextjs-ui` - Next.js UI development
62+
- `react-components` - React components best practices
63+
- `react-typescript` - React with TypeScript
64+
- `styled-components` - Styled components guidelines
65+
66+
**Backend Development**
67+
- `go-backend` - Go backend scalability
68+
- `java-springboot` - Java Spring Boot patterns
69+
- `django-best-practices` - Python Django guidelines
70+
- `nestjs-typescript` - NestJS TypeScript
71+
- `express-mongodb` - Express with MongoDB
72+
73+
**Others**
74+
- `convex` - Convex database rules
75+
- `dragonruby` - DragonRuby best practices
76+
- `elixir-engineer` - Elixir engineering guidelines
77+
- `github-code-quality` - GitHub code quality
78+
- `typescript-axios` - TypeScript Axios integration
79+
- `typescript-conventions` - TypeScript conventions
80+
- `vite-tailwind` - Vite with Tailwind CSS
81+
82+
### 📖 Documentation
83+
84+
#### Added
85+
- Complete rewrite of `docs/getting-started.md` - Three-step quick start guide
86+
- Complete rewrite of `docs/best-practices.md` - Comprehensive best practices manual
87+
- Complete rewrite of `docs/installation-guide.md` - Multi-platform installation guide
88+
- Complete rewrite of `docs/troubleshooting.md` - Troubleshooting toolbox
89+
- Complete rewrite of `CONTRIBUTING.md` - Contribution guidelines and glossary
90+
- Complete rewrite of `README.md` - Streamlined project homepage
91+
92+
### 🐛 Bug Fixes
93+
94+
- Removed duplicate directory `rules/frontend/mobile/`
95+
- Merged duplicate Flutter rules directories
96+
- Fixed invalid path references in documentation
97+
- Added missing `.cursorrules` files
98+
99+
### 🔧 Changed
100+
101+
- Updated project statistics: 119 rule files, 43 tech categories, 568 documents
102+
- Unified rules file format and style
103+
- Optimized directory structure organization
41104

42105
---
43106

44-
## [1.5.0] - 2025-07-03
107+
## [1.5.0] - 2024-07-03
45108

46-
### 新增
109+
### ✨ Features
47110

48-
- 完成所有规则集翻译(100%
49-
- 更新核心文档反映项目进入维护阶段
111+
- Completed all rules translation (100%)
112+
- Updated core documentation to reflect maintenance phase
50113

51114
---
52115

53-
## [1.4.0] - 2025-07-02
116+
## [1.4.0] - 2024-07-02
54117

55-
### 新增
118+
### ✨ Features
56119

57-
- 完成全部规则集翻译
58-
- 更新文档反映翻译进度
120+
- Completed full rules translation
121+
- Updated documentation to reflect translation progress
59122

60123
---
61124

62-
## [1.3.0] - 2025-07-02
125+
## [1.3.0] - 2024-07-02
63126

64-
### 新增
127+
### ✨ Features
65128

66-
- Elixir 工程师指南翻译
67-
- 工程工单模板翻译
68-
- Gherkin 风格测试翻译
69-
- Git 约定式提交消息翻译
70-
- GitHub 代码质量翻译
71-
- Xray 测试用例翻译
129+
- Elixir engineer guidelines translation
130+
- Engineering ticket template translation
131+
- Gherkin style testing translation
132+
- Git conventional commit messages translation
133+
- GitHub code quality translation
134+
- Xray test case translation
72135

73136
---
74137

75-
## [1.2.0] - 2025-07-02
138+
## [1.2.0] - 2024-07-02
76139

77-
### 新增
140+
### ✨ Features
78141

79-
- 50 份新文档翻译(总进度 95%
80-
- 翻译进度报告结构重构
81-
- 翻译问题排查指南
142+
- 50 new document translations (95% total progress)
143+
- Restructured translation progress reporting
144+
- Translation troubleshooting guide
82145

83-
### 完成
146+
### ✅ Completed
84147

85-
- 云原生领域 100%
86-
- 移动开发领域 100%
148+
- Cloud-native domain: 100%
149+
- Mobile development domain: 100%
87150

88151
---
89152

90-
## [1.1.0] - 2025-06-25
153+
## [1.1.0] - 2024-06-25
91154

92-
### 新增
155+
### ✨ Features
93156

94-
- Django 全规则集翻译
95-
- FastAPI 核心规范翻译
96-
- 数据科学领域:Python 数据处理、PandasMatplotlibPyTorchTensorFlow
97-
- 机器学习:Scikit-learn 最佳实践
157+
- Django full rules set translation
158+
- FastAPI core standards translation
159+
- Data Science domain: Python data processing, Pandas, Matplotlib, PyTorch, TensorFlow
160+
- Machine Learning: Scikit-learn best practices
98161

99162
---
100163

101164
## [1.0.0] - 2024-01-01
102165

103-
### 新增
166+
### 🎉 Initial Release
104167

105-
首次正式发布
168+
First official release.
106169

107-
#### 规则集(29 个)
170+
#### Rule Sets (29 Total)
108171

109-
**React 生态(13 个)**
172+
**React Ecosystem (13)**
173+
- Next.js + TypeScript complete configuration
174+
- React component development best practices
175+
- Chakra UI and Styled Components style guides
176+
- GraphQL Apollo Client integration
177+
- MobX state management
178+
- React Native Expo mobile development
110179

111-
- Next.js + TypeScript 完整配置
112-
- React 组件开发最佳实践
113-
- Chakra UI 和 Styled Components 样式指南
114-
- GraphQL Apollo Client 集成
115-
- MobX 状态管理
116-
- React Native Expo 移动开发
180+
**Vue Ecosystem (2)**
181+
- Vue 3 Composition API development standards
182+
- Nuxt 3 full-stack development guide
117183

118-
**Vue 生态(2 个)**
119-
120-
- Vue 3 Composition API 开发规范
121-
- Nuxt 3 全栈开发指南
122-
123-
**TypeScript 专项(3 个)**
124-
125-
- TypeScript 编码约定
126-
- Vite + Tailwind CSS 构建
127-
- Axios HTTP 客户端集成
128-
129-
**后端开发(6 个)**
184+
**TypeScript Specific (3)**
185+
- TypeScript coding conventions
186+
- Vite + Tailwind CSS build setup
187+
- Axios HTTP client integration
130188

189+
**Backend Development (6)**
131190
- Python FastAPI
132191
- Node.js Express + MongoDB
133192
- TypeScript NestJS
134-
- ASP.NET ABP 框架
135-
136-
**其他(5 个)**
193+
- ASP.NET ABP framework
137194

138-
- React Native Expo 跨平台
139-
- iOS UIKit 原生开发
140-
- Solidity Foundry 智能合约
141-
- C++ 现代编程规范
195+
**Others (5)**
196+
- React Native Expo cross-platform
197+
- iOS UIKit native development
198+
- Solidity Foundry smart contracts
199+
- C++ modern programming standards
142200
- Drupal 11 CMS
143201

144-
#### 基础设施
202+
#### Infrastructure
145203

146-
- 按技术栈分类的目录结构
147-
- 中文 README 和文档
148-
- GitHub Actions 质量检查
149-
- Issue PR 模板
150-
- 行为准则和贡献指南
204+
- Tech-stack categorized directory structure
205+
- Chinese README and documentation
206+
- GitHub Actions quality checks
207+
- Issue and PR templates
208+
- Code of conduct and contribution guidelines
151209

152210
---
153211

154-
## 版本说明
212+
## Version Guide
213+
214+
| Version | Meaning |
215+
|---------|---------|
216+
| Major | Breaking changes, major architecture updates |
217+
| Minor | New features, significant improvements |
218+
| Patch | Bug fixes and small improvements |
219+
220+
## Migration Guides
221+
222+
### Migrating to 2.1.0
223+
224+
Documentation paths have been restructured:
225+
226+
**Old Paths** (still work with redirects):
227+
```
228+
docs/getting-started.md
229+
docs/best-practices.md
230+
docs/installation-guide.md
231+
docs/troubleshooting.md
232+
```
233+
234+
**New Paths**:
235+
```
236+
docs/zh/getting-started.md # Chinese
237+
docs/en/getting-started.md # English
238+
```
239+
240+
No action required - old paths are automatically redirected.
241+
242+
---
155243

156-
| 版本号 | 含义 |
157-
|--------|------|
158-
| 主版本 | 重大架构变更 |
159-
| 次版本 | 新功能或重要改进 |
160-
| 修订号 | Bug 修复和小改进 |
244+
[Unreleased]: https://github.com/LessUp/awesome-cursorrules-zh/compare/v2.1.0...HEAD
245+
[2.1.0]: https://github.com/LessUp/awesome-cursorrules-zh/compare/v2.0.0...v2.1.0
246+
[2.0.0]: https://github.com/LessUp/awesome-cursorrules-zh/compare/v1.5.0...v2.0.0
247+
[1.5.0]: https://github.com/LessUp/awesome-cursorrules-zh/compare/v1.4.0...v1.5.0
248+
[1.4.0]: https://github.com/LessUp/awesome-cursorrules-zh/compare/v1.3.0...v1.4.0
249+
[1.3.0]: https://github.com/LessUp/awesome-cursorrules-zh/compare/v1.2.0...v1.3.0
250+
[1.2.0]: https://github.com/LessUp/awesome-cursorrules-zh/compare/v1.1.0...v1.2.0
251+
[1.1.0]: https://github.com/LessUp/awesome-cursorrules-zh/compare/v1.0.0...v1.1.0
252+
[1.0.0]: https://github.com/LessUp/awesome-cursorrules-zh/releases/tag/v1.0.0

0 commit comments

Comments
 (0)