Files
xlgo-core/docs/README.md
T
杭州明婳科技 deb3cc71bf feat(v1.0.4): DX & Docs 改进
按报告 v1.0.4 路线图完成 5 项开发体验与文档改进:

#25 模块路径文档改进:
- 保留 -core 后缀(xlgo 是多产品系列:xlgo-core/xlgo-orm/xlgo-ai)
- README 快速开始补完整 import 示例 + 新增「模块路径与包名」小节
- CLAUDE.md Import Path Note 措辞明确化

#27 Without* Option 定位文档化:
- 调研确认 Without* 有真实用例(测试覆盖 + NewFullStack 后排除单项)
- 不删不标 Deprecated,在 app.go 注释 + README 说明其定位

#28 CLI 多模板:
- xlgo new --template minimal/api/fullstack
- minimal 轻量HTTP无依赖,api 标准业务分层(默认),fullstack 全组件
- 三模板实测生成正确

#29 examples/ 目录:
- examples/minimal(50行可跑,无外部依赖)
- examples/full(mysql+redis+jwt+user CRUD)
- examples/README.md

#30 文档结构:
- Version_*.md + report.md 移到 docs/plans/(v2.0-review.md)
- 新增 docs/README.md 索引
- CHANGELOG/GUIDE 留根目录(按惯例)
- .gitignore 整理

build/vet/test + examples 编译全绿。

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-22 23:21:59 +08:00

920 B
Raw Blame History

xlgo 文档

文档 位置 说明
README.md 仓库根 快速开始、功能概览、更新日志
GUIDE.md 仓库根 完整使用指南
CHANGELOG.md 仓库根 变更日志(遵循 Keep a Changelog
CLAUDE.md 仓库根 Claude Code 协作指引
docs/plans/ 本目录 历史版本规划与体检报告归档

docs/plans/ 归档文档

这些是各版本开发时的规划/评审文档,反映当时状态,代码可能已演进,阅读时请对照 CHANGELOG 确认现状。

文件 说明
Version_Update_Plan_v1.0.2.md v1.0.2 更新计划(已完成)
Version_v1.0.2_report.md v1.0.2 体检报告,含 #1-#30 改进建议与版本路线图
v2.0-review.md 更早期的 v2.0 评估报告

v1.0.2 体检报告中的 #1-#30 改进项,完成情况见根目录 CHANGELOG.md 各版本章节。