Skip to content

Remove unused documentation files - #83

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

Remove unused documentation files#83
mijun (houlianpi) merged 1 commit into
mainfrom
codex/remove-unused-docs

Conversation

@houlianpi

Copy link
Copy Markdown
Contributor

Summary

Remove unused tracked documentation, a duplicate docs index, and stale one-off launch/design material. Synchronize the source-distribution include set and its contract test without changing runtime behavior or release workflows.

Related issue

N/A. Repository documentation cleanup.

Design document

N/A. Implemented from a direct /spec-driven request.

SPEC updates

No SPEC delta. Root SPEC.md remains the current product and architecture authority. The removed files do not define current public behavior, interfaces, configuration, module ownership, or dependency direction.

Changes

Removed:

  • docs/README.md, a duplicate documentation index with no inbound references.
  • docs/examples/complete_all_menu_workflow_through_overflow_menu_on_ntp.example.fsq.yaml, an unreferenced secondary example outside the canonical top-level examples/ directory.
  • Two one-off v0.1.0 launch articles under docs/launch/.
  • Two tracked historical CLI design/discussion documents under docs/superpowers/specs/.

Updated:

  • Removed /docs/README.md and /docs/launch from the sdist include set.
  • Removed the corresponding expectations from the distribution contract test.

Preserved:

  • The canonical top-level examples/ directory and public Web Case.
  • The docs/superpowers/specs/YYYY-MM-DD-<topic>-design.md workflow path used by repository skills.
  • Git-ignored local design documents under docs/superpowers/specs/.
  • Current user documentation, releases, media, and docs/demo.html.

Verification

  • Removed-file and path reference scan: no remaining references.
  • Repository skills still reference the docs/superpowers/specs/YYYY-MM-DD-<topic>-design.md workflow path.
  • 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 caused by ignored stale fsq_agent/playground/__pycache__ namespace files.

Evidence

N/A. Documentation and distribution-manifest cleanup only.

Release or documentation impact

The source distribution no longer includes the duplicate docs index or launch articles. Current public documentation and canonical examples remain available. CI and release workflows are unchanged.

Audit

The complete no-SPEC-delta audit passed with coverage_complete=true, every applicable item implemented, zero blocking findings, and zero accepted human-decision items. Audited artifact SHA-256: 9479fc4bc394b4558030e94c17913008ea53a3f302bfc7038eee247f512285fa.

Checklist

Spec-driven development

  • Root SPEC was reviewed.
  • No SPEC delta is required.
  • The final complete audit passed.

Quality and safety

  • Focused tests and formatting/lint checks were run.
  • No current public documentation or canonical example was removed.
  • No credentials, private data, generated logs, reports, or workspace output were added.
  • No binary media was added.

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