Refresh public documentation - #82
Merged
Merged
Conversation
mijun (houlianpi)
requested review from
tongyu70020 and
ZhengdaWang (zhengdawang443)
as code owners
September 2, 2026 14:07
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Keep the public documentation set focused and current: refresh the Case format, platform prerequisites, and support/stability pages; remove unmaintained architecture, release-checklist, migration, and roadmap documents; and synchronize all links, packaging declarations, release copy, and related tests.
Related issue
N/A. This is documentation and repository-maintenance cleanup with no product behavior change.
Design document
N/A. Implemented from a direct
/spec-drivenrequest.SPEC updates
No SPEC delta. Root
SPEC.mdand thecase_dsl,config,environments, andclimodule specs already define the current Case, platform prerequisite, Python support, CI, configuration, and ownership contracts. This change aligns public documentation with those existing contracts.Changes
Updated and retained:
docs/case-format.md: independent TodoMVC minimum Case plus the current recorded public workflow.docs/platform-prerequisites.md: exact Web channel/discovery rules and operator-owned platform prerequisites.docs/support-and-stability.md: Python 3.11-3.13 support and the actual CI host/version matrix.Removed:
docs/architecture.mddocs/release-acceptance-checklist.mddocs/package-directory-migration-guide.mdROADMAP.mdSynchronized README navigation, Chinese documentation, Getting Started guides, launch copy, Governance, release notes, sdist inputs, and the distribution contract test.
Verification
versioned/版本化main-download scans: no remaining matches.git diff --check: passed.uv run --no-sync ruff format --check .: passed; 259 files already formatted.uv run --no-sync ruff check .: passed.uv run --no-sync python -m pytest tests/test_distribution_contract.py -q: 11 passed.uv run --no-sync python -m pytest: 936 passed, 1 skipped, 1 unrelated local-environment failure. The failure is caused by ignored stalefsq_agent/playground/__pycache__files making the removed namespace locally discoverable.Evidence
N/A. Documentation-only visible changes.
Release or documentation impact
Public navigation now retains only maintained documentation. Release notes point to the configured CI and release workflows rather than an unused manual checklist. No CI or release workflow was changed.
Audit
The final no-SPEC-delta audit was confirmed passed with no blocking findings. The audited pre-commit diff SHA-256 was
e32d42242669b5ff3843912e07d4f8dd4325c4910da036bc82d520da8aae5581.Checklist
Spec-driven development
Quality and safety