Skip to content

docs: slim swiss-design.md into architecture.md and add DEVELOPMENT.md - #32

Merged
aceforeverd merged 2 commits into
modelsphere:masterfrom
huskcass:docs/architecture
Oct 24, 2026
Merged

aceforeverd merged 2 commits into
modelsphere:masterfrom
huskcass:docs/architecture

Conversation

@huskcass

Copy link
Copy Markdown
Collaborator
  • Rename `docs/swiss-design.md` to `docs/architecture.md` and keep only the core architecture: components, layers, pipeline. Drop the Uninstalling and Catalog detail sections; detail docs can come later as their own files.
  • Add `DEVELOPMENT.md`: prerequisites, build, run, unit and e2e tests, lint, PRs.
  • Update references in README.md and AGENTS.md.

@huskcass huskcass left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

No blockers at 92517ed.

Verdict: docs-only, links, mermaid and commands check out; worth adding to DEVELOPMENT.md that a local make test needs model-catalog cloned to ../swiss-catalog at CATALOG_REF (the server tests fail without it), and the Uninstalling section from #31 has no other home yet.
— Review Golden

@huskcass

Copy link
Copy Markdown
Collaborator Author

Added the local test prerequisite to DEVELOPMENT.md in 9d764d0: make test needs model-catalog cloned to ../swiss-catalog at CATALOG_REF. Leaving the Uninstalling section out on purpose: architecture.md stays core-only, and that topic gets its own doc later.

@aceforeverd
aceforeverd merged commit aad7f9f into modelsphere:master Oct 24, 2026
4 checks passed
@huskcass
huskcass deleted the docs/architecture branch October 24, 2026 08:27

@huskcass huskcass left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

No blockers at 9d764d0.

Verdict: the catalog clone steps work as written and make test passes with CATALOG_REF; leaving Uninstalling for its own doc is a placement choice, fine as long as that doc follows.
— Review Golden

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.

2 participants