Skip to content

Remove obsolete documentation drafts - #81

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

mijun (houlianpi) merged 1 commit into
mainfrom
codex/docs-cleanup

Conversation

@houlianpi

Copy link
Copy Markdown
Contributor

Summary

Remove obsolete, unreferenced documentation drafts and the assets used exclusively by those drafts. Keep the current user documentation, release material, docs/architecture.md, and docs/demo.html.

Related issue

N/A. This is documentation repository cleanup and does not change supported behavior.

Design document

N/A. Direct /spec-driven documentation cleanup request.

SPEC updates

No SPEC delta. Root SPEC.md already establishes root and module specs as the current architecture and behavior authority. The removed files were historical prototypes or target-state drafts and were not current contract inputs.

Changes

Removed:

  • docs/control-plane-ux.html: obsolete standalone product UX prototype containing legacy .codex.yaml examples.
  • docs/step-runner-architecture.md: unreferenced runner design discussion with future/target-state language.
  • docs/openai-agent-loop.md: unreferenced early SDK/provider loop description.
  • docs/fsq-agent-architecture-v2.md: early architecture draft.
  • docs/fsq-agent-architecture-deep-dive.md: early team-review architecture draft.
  • Seven PNG, SVG, and Mermaid assets referenced only by those architecture drafts.

Preserved:

  • docs/architecture.md
  • docs/demo.html
  • Current getting-started, CLI, Case, platform, stability, release, launch, and media documentation
  • Maintainer release material and tracked design records

Verification

  • Repository reference scan for every removed filename: no remaining references.
  • 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: 12 passed.
  • uv run --no-sync python -m pytest: 937 passed, 1 skipped, 1 unrelated local-environment failure. The failure is test_legacy_playground_packages_are_absent, caused by ignored stale fsq_agent/playground/__pycache__ files making the removed namespace package locally discoverable.

Evidence

N/A. The change removes obsolete documentation and has no UI behavior.

Release or documentation impact

Reduces repository documentation ambiguity and removes approximately 6,797 lines plus one obsolete binary architecture image. Published user documentation and the demo page remain unchanged.

Checklist

Spec-driven development

  • I reviewed root SPEC.md.
  • No SPEC delta is required because no current supported behavior or contract changes.
  • The retained documentation remains aligned with current SPEC files.
  • I used current SPEC files as the source of truth.

Quality and safety

  • I ran focused verification and required formatting/lint checks.
  • User-facing documentation remains available and unchanged.
  • No credentials, private data, generated logs, reports, screenshots, or workspace output were added.
  • No binary media was added.

@houlianpi
mijun (houlianpi) merged commit 9f86eaf 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