docs(architecture-diagram): 架构图重生成后丢失了原有的语义架构信息

Open
#371 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
74/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
documentation

Research direction

Start by comparing docs/architecture-diagram.dot, docs/architecture.md, and docs/index.md, then read the issue's referenced architecture concepts and the gf-architecture-diagram SKILL.md. Add a manually maintained architecture-internals document covering Provider Traits, Domain Types, CoreError, external CLIs, git, and the platform_detect -> git_bin risk. Update docs/index.md to explain the boundary between the two diagrams, without changing the skill.

Written by the indexing model from the issue text.

Description

documentation enhancement priority:low triage:done type:docs

Context

在 Issue #331（新增 gf-architecture-diagram skill）的最终交付中，docs/architecture-diagram.dot 从手工维护的版本被完全替换为纯 crate 依赖图（11 节点 / 13 边，从 cargo metadata --no-deps --format-version=1 提取）。

旧图里承载的、对 onboarding 和设计评审真正有价值的架构信息——Provider Traits、Domain Types、CoreError、External Dependencies 集群（gh/glab/gitcode CLI、git 二进制）以及 platform_detect -> git_bin 这条被标红的同步调用——全部被丢弃，且 docs/architecture.md 并未覆盖这些内容。

这是 Issue #331 计划阶段的一个取舍（Task 6 按计划只做依赖图），不是实现缺陷，但造成了真实的架构文档信息损失。

Goal

补上一份手工维护的架构内幕文档，与 gf-architecture-diagram 生成的依赖图分工：后者管「模块依赖不漂移」，前者管「设计意图与外部依赖风险」。

Acceptance Criteria

  • 新增 docs/architecture-internals.dot（或等价文档），涵盖 Provider Traits、Domain Types、CoreError 等语义架构内容
  • 覆盖 External Dependencies 集群（gh/glab/gitcode CLI、git 二进制）及其同步调用风险点（如 platform_detect -> git_bin）
  • docs/index.md 收录该文档并说明与 docs/architecture-diagram.dot（依赖图）的分工边界
  • gf-architecture-diagram 的 SKILL.md 保持不变——该 skill 的 "When NOT to Use" 已明确允许手绘概念图，这份新文档不与该 skill 的自动生成职责冲突
Dominant language
Rust
Stars
2
Forks
2
Avg merge
11m
Merged PRs (30d)
50

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from byx-darwin/gitflow-cli

All issues in byx-darwin/gitflow-cli

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.