---
id: TASK-4.3
title: Update user-facing docs/help for compile_commands.json symlink behavior
status: Done
assignee:
  - codex
created_date: '2026-01-30 09:02'
updated_date: '2026-01-30 09:16'
labels:
  - docs
  - build
  - profiles
  - lsp
  - compile-commands
dependencies:
  - TASK-4.1
references:
  - README.md
  - bin/zync
parent_task_id: TASK-4
---

## Description

<!-- SECTION:DESCRIPTION:BEGIN -->
Update user-facing documentation or CLI help to mention the compile_commands.json symlink behavior for build profiles, or record that no documentation change is needed.
<!-- SECTION:DESCRIPTION:END -->

## Acceptance Criteria
<!-- AC:BEGIN -->
- [x] #1 User-facing documentation or CLI help is updated to mention compile_commands.json symlink behavior for build profiles, or a decision is recorded in a repo doc (README, changelog, or docs) stating no update is needed.
<!-- AC:END -->

## Implementation Plan

<!-- SECTION:PLAN:BEGIN -->
- Scan README and CLI help text for the best place to mention the compile_commands.json symlink behavior with build profiles.
- Add a brief note explaining that zync ensures build/compile_commands.json links to the default/first profile’s build dir when profiles are configured (for non-metadata commands).
- Keep the note minimal and consistent with existing documentation style.
<!-- SECTION:PLAN:END -->

## Implementation Notes

<!-- SECTION:NOTES:BEGIN -->
Plan approved by user on 2026-01-30.

Added README note under Build output layout about compile_commands.json symlink to default/first profile for LSP indexing.
<!-- SECTION:NOTES:END -->
