From 06c5d10bafd5a8bb61284fcd9a5db610ad0cd098 Mon Sep 17 00:00:00 2001 From: Matt Bruce Date: Sat, 10 Jan 2026 15:29:22 -0600 Subject: [PATCH] Signed-off-by: Matt Bruce --- Agents.md | 43 ++++++++++--------------------------------- 1 file changed, 10 insertions(+), 33 deletions(-) diff --git a/Agents.md b/Agents.md index 722fd16..d21d466 100644 --- a/Agents.md +++ b/Agents.md @@ -2,14 +2,15 @@ This repository contains an Xcode project written with Swift and SwiftUI. Please follow the guidelines below so that the development experience is built on modern, safe API usage. -## Additional Context Files (Read First) +## Additional Context Files -**These files are kept in sync and MUST be updated together when making changes:** +Before starting work, read project documentation: -- `README.md` — Product scope, features, and project structure -- `ai_implementation.md` — AI implementation context and architecture notes +- `WORKSPACE.md` — (if present) Multi-project workspace overview and project relationships +- `README.md` — Project scope, features, and architecture +- In multi-project workspaces, each project folder has its own `README.md` -See **Documentation Instructions** section for mandatory sync requirements. +When making architectural changes, keep documentation files in sync with code changes. ## Role @@ -731,36 +732,12 @@ Then clean build (⇧⌘K) and rebuild. Everything updates automatically—inclu ## Documentation Instructions -### MANDATORY: Keep Documentation Files in Sync - -⚠️ **These three files MUST be updated together when making architectural changes:** - -| File | Purpose | -|------|---------| -| `Agents.md` | Agent instructions and coding standards | -| `README.md` | Product scope, features, and project structure | -| `ai_implementation.md` | AI implementation context and architecture notes | - -**When to update all three:** -- Adding new features or services -- Changing architecture patterns (e.g., WatchConnectivity vs App Groups) -- Modifying model structure (e.g., adding/removing properties) -- Learning important lessons (e.g., watch embedding requirements) -- Changing project structure or file organization - -**Update checklist:** -1. ✅ `Agents.md` — Add instructions/guidelines for the change -2. ✅ `README.md` — Update features, architecture, or structure sections -3. ✅ `ai_implementation.md` — Update models, services, files, or lessons learned - -### General Documentation Rules - -- **Keep `README.md` up to date** when adding new functionality. -- Document new features, settings, or mechanics in the README. -- Update the README when modifying existing behavior. +- **Keep `README.md` files up to date** when adding new functionality. +- In multi-project workspaces, update the relevant project's `README.md`. +- Document new features, settings, or mechanics in the appropriate README. +- Update documentation when modifying existing behavior. - Include configuration options and special interactions. - README updates should be part of the same commit as the feature. -- Maintain a `ROADMAP.md` for tracking feature status. ## PR Instructions