From ef66e65db621e54d103a7d5281baaadd4452d137 Mon Sep 17 00:00:00 2001 From: Bill Murdock Date: Tue, 19 May 2026 15:20:13 -0400 Subject: [PATCH] docs: flag bootstrap overwrite behavior as not yet implemented The user guide and developer guide both claim bootstrap never overwrites existing files, but only CONTRIBUTING.md and CODE_OF_CONDUCT.md are currently protected. Add warnings linking to #449 so users know the guarantee is not yet fully enforced. Co-Authored-By: Claude Opus 4.6 --- docs/developer-guide.md | 2 +- docs/user-guide.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer-guide.md b/docs/developer-guide.md index b258af43..4617c062 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -397,7 +397,7 @@ class BootstrapGenerator: - `_render_template()` — Render Jinja2 template with context variables - `_get_templates_for_language()` — Map language to template files - `_write_file()` — Create file on disk (respects dry_run) -- `_file_exists()` — Check for conflicts (never overwrites) +- `_write_file()` — Write file to disk (⚠️ currently overwrites existing files, see [#449](https://github.com/ambient-code/agentready/issues/449)) #### 2. Bootstrap CLI (`cli/bootstrap.py`) diff --git a/docs/user-guide.md b/docs/user-guide.md index 7b8b8178..0bb7b19c 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -98,7 +98,7 @@ Bootstrap is AgentReady's automated infrastructure generator. One command create **Safe by Design**: - Use `--dry-run` to preview changes -- Never overwrites existing files +- Never overwrites existing files (⚠️ [not yet fully implemented](https://github.com/ambient-code/agentready/issues/449), currently only `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are protected) - Review with `git status` before committing ### When to Use Bootstrap vs Assess