Skip to content

docs(architecture): align Studio docs with current boundaries - #51

Merged
ShuhaoZhangTony merged 1 commit into
mainfrom
codex/issue-30-docs-consistency
Jul 30, 2026
Merged

docs(architecture): align Studio docs with current boundaries#51
ShuhaoZhangTony merged 1 commit into
mainfrom
codex/issue-30-docs-consistency

Conversation

@ShuhaoZhangTony

Copy link
Copy Markdown
Contributor

Summary

  • replace the historical monorepo/chat-oriented README with the current visual workflow editor boundary
  • document the real FastAPI entry point, CLI surface, project layout, installation, and validation commands
  • remove references to deleted modules, missing scripts, and the old organization location
  • update contributor/Copilot guidance and run CI for documentation-only pull requests
  • add regression tests for removed runtime paths, broken local links, and the backend entry point

Validation

  • python3 -m pytest -q tests/test_docs_consistency.py tests/test_boundary_dependency_audit.py tests/test_runtime_cleanup_guardrails.py
  • ruff check tests/test_docs_consistency.py
  • ruff format --check tests/test_docs_consistency.py
  • result: 14 passed; lint and format checks passed

Closes #30.

@ShuhaoZhangTony
ShuhaoZhangTony merged commit feb534c into main Jul 30, 2026
3 checks passed
@ShuhaoZhangTony
ShuhaoZhangTony deleted the codex/issue-30-docs-consistency branch July 30, 2026 10:29
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.

docs(architecture): 对齐 README/CONTRIBUTING 与实际实现并加一致性检查

1 participant