---
id: TASK-8.3
title: Update docs/help for `zync clean` behavior
status: Done
assignee:
  - codex
created_date: '2026-02-03 17:47'
updated_date: '2026-02-03 18:07'
labels:
  - docs
  - clean
  - build
dependencies:
  - TASK-8.1
references:
  - README.md
  - bin/zync
parent_task_id: TASK-8
---

## Description

<!-- SECTION:DESCRIPTION:BEGIN -->
Update user-facing documentation or CLI help to describe that `zync clean` removes the entire root build directory, while `-c/--clean` pre-clean remains targeted; or record that no doc change is needed.
<!-- SECTION:DESCRIPTION:END -->

## Acceptance Criteria
<!-- AC:BEGIN -->
- [x] #1 User-facing documentation or CLI help reflects the `zync clean` full-build cleanup behavior (or a decision is recorded that no update is required).
<!-- AC:END -->

## Implementation Plan

<!-- SECTION:PLAN:BEGIN -->
- Review README.md and bin/zync help output to find current clean/--clean wording.
- Update the most user-facing spot(s) to clarify: zync clean removes the entire root ./build directory, while -c/--clean pre-clean only targets the selected build dir/profile.
- If no doc changes are needed, record that decision in the task notes instead.
- Re-run zync --help (if needed) to confirm wording, then update acceptance criteria.
<!-- SECTION:PLAN:END -->

## Implementation Notes

<!-- SECTION:NOTES:BEGIN -->
Updated README usage/commands/pre-clean note to clarify clean removes root build dir while -c targets selected build dir/profile.

Updated CLI help strings for --clean flag and clean command description.

Tests not run (doc/help only).
<!-- SECTION:NOTES:END -->

## Final Summary

<!-- SECTION:FINAL_SUMMARY:BEGIN -->
Clarified README usage and command summaries to state that `zync clean` removes the entire root build directory while `-c/--clean` only pre-cleans the selected build dir/profile. Updated CLI help text for the clean command and pre-clean flag to match. Tests not run (doc/help only).
<!-- SECTION:FINAL_SUMMARY:END -->
