olafn/infoscreen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: archive legacy guides and streamline copilot instructions governance

Browse Source
This commit is contained in:
Olaf
2026-04-01 08:37:50 +00:00
parent 365d8f58f3
commit 06411edfab
15 changed files with 199 additions and 580 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
AI-INSTRUCTIONS-MAINTENANCE.md
View File

@@ -36,6 +36,27 @@ Update the instructions in the same commit as your change whenever you:
- Include concrete examples from this repo when describing patterns (e.g., which route shows enum serialization).
- Never include secrets or real tokens; show only variable names and example formats.
## Scope boundaries (important)
To avoid turning `.github/copilot-instructions.md` into a shadow README/changelog, keep clear boundaries:
- `.github/copilot-instructions.md`: quick operational brief for agents (architecture snapshot, non-negotiable conventions, key paths, critical contracts).
- `README.md`: project entrypoint and documentation navigation.
- `TECH-CHANGELOG.md` and `DEV-CHANGELOG.md`: change history and release/development notes.
- Feature contracts/specs: dedicated files (for example `MQTT_EVENT_PAYLOAD_GUIDE.md`, `TV_POWER_INTENT_SERVER_CONTRACT_V1.md`).
Do not place long historical sections, release summaries, or full endpoint catalogs in `.github/copilot-instructions.md`.
## Size and quality guardrails
- Target size for `.github/copilot-instructions.md`: about 120-220 lines.
- If a new section exceeds ~10 lines, prefer linking to an existing canonical doc instead.
- Keep each section focused on actionability for coding agents.
- Remove duplicate rules if already stated in another section.
- Use concise bullets over long prose blocks.
Quick pre-commit check:
- Is this content a rule/pattern needed during coding now?
- If it is historical context, move it to changelog/archive docs.
- If it is deep reference material, move it to the canonical feature doc and link it.
## Solo-friendly workflow
- Update docs in the same commit as your change:
- Code changed → docs changed (copilot-instructions, `.env.example`, `deployment.md` as needed)
@@ -101,4 +122,5 @@ exit 0 # warn only; do not block commit
- Dev/Prod docs: `deployment.md`, `.env.example`
## Documentation sync log
- 2026-03-24: Synced docs for completed monitoring rollout and presentation flag persistence fix (`page_progress` / `auto_progress`). Updated `.github/copilot-instructions.md`, `README.md`, `TECH-CHANGELOG.md`, `DEV-CHANGELOG.md`, and `CLIENT_MONITORING_IMPLEMENTATION_GUIDE.md` without a user-version bump.
- 2026-03-24: Synced docs for completed monitoring rollout and presentation flag persistence fix (`page_progress` / `auto_progress`). Updated `.github/copilot-instructions.md`, `README.md`, `TECH-CHANGELOG.md`, `DEV-CHANGELOG.md`, and `docs/archive/CLIENT_MONITORING_IMPLEMENTATION_GUIDE.md` without a user-version bump.
- 2026-04-01: Synced docs for TV power intent Phase 1 implementation and contract consistency. Updated `.github/copilot-instructions.md`, `MQTT_EVENT_PAYLOAD_GUIDE.md`, `docs/archive/TV_POWER_PHASE_1_SERVER_HANDOFF.md`, `TECH-CHANGELOG.md`, and `DEV-CHANGELOG.md` to match scheduler behavior (`infoscreen/groups/{group_id}/power/intent`, `schema_version: "1.0"`, transition + heartbeat semantics, poll-based expiry).