Skip to content

Refresh public documentation - #82

Merged
mijun (houlianpi) merged 1 commit into
mainfrom
codex/documentation-cleanup
Sep 2, 2026
Merged

Refresh public documentation#82
mijun (houlianpi) merged 1 commit into
mainfrom
codex/documentation-cleanup

Conversation

@houlianpi

Copy link
Copy Markdown
Contributor

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-driven request.

SPEC updates

No SPEC delta. Root SPEC.md and the case_dsl, config, environments, and cli module 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.md
  • docs/release-acceptance-checklist.md
  • docs/package-directory-migration-guide.md
  • ROADMAP.md

Synchronized README navigation, Chinese documentation, Getting Started guides, launch copy, Governance, release notes, sdist inputs, and the distribution contract test.

Verification

  • Removed-path, stale-link, old checklist statement, public Example Domain description, and 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 stale fsq_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

  • Root and relevant module specs were reviewed.
  • No SPEC delta is required.
  • Documentation agrees with current confirmed SPEC files.
  • The final audit was confirmed passed.

Quality and safety

  • Focused tests and formatting/lint checks were run.
  • User-facing documentation was updated.
  • No credentials, private data, generated logs, reports, or workspace output were added.
  • No binary media was added.

@houlianpi
mijun (houlianpi) merged commit 1889be9 into main Sep 2, 2026
10 checks passed
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.

1 participant