Skip to content

docs: add architecture overview with system diagrams - #62

Open
xiaocheny214 wants to merge 1 commit into
1024XEngineer:mainfrom
xiaocheny214:docs/add-skeleton-with-module-contracts
Open

docs: add architecture overview with system diagrams#62
xiaocheny214 wants to merge 1 commit into
1024XEngineer:mainfrom
xiaocheny214:docs/add-skeleton-with-module-contracts

Conversation

@xiaocheny214

Copy link
Copy Markdown

变更范围

添加系统架构说明文档,偏向后端理解。

@fennoai fennoai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The architecture document is useful as a target design, but several statements currently read as repository facts while the referenced implementation/configuration is not present. Please either add the missing artifacts or clearly label these items as planned/proposed.

Comment thread docs/architecture.md
- 最终工作流能力如何从当前 Demo 演进;
- 哪些边界和依赖必须长期保持。

当前前端文档 `docs/frontend-architecture.md` 描述的是 **MS2 阶段的前端 FSD 架构**。其中 `WorkflowRun` 是前端用于组织页面推进状态的 Entity,不要求后端建立同名领域模块。前端 Demo 可以直接调用后端的项目、角色、生成、审核、资产和导出接口。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[medium] This references docs/frontend-architecture.md, but that file does not exist on either this PR branch or main. Readers cannot follow the stated MS2 FSD/WorkflowRun context; please add the referenced document or change this to a planned/external reference.

Comment thread docs/architecture.md

源文件:[`backend-layers.json`](diagrams/backend-layers.json)

后端采用 uv workspace monorepo,当前由四个独立包组成:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[medium] The wording says the repository currently consists of a four-package uv workspace monorepo, but this repository currently contains only README.md plus the new docs and has no workspace/package configuration. Please label this as the target structure until the packages are actually added.

Comment thread docs/architecture.md
common
```

当前已通过 `import-linter` 强制:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[high] This states that import-linter already enforces the dependency rules, but the repository has no Python project configuration, dependency, or lint contract implementing that check. Presenting this as enforced can give contributors false confidence; either add the check or mark it as planned.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants