From 112cbbcd37c9e68359aa84fdc0965ebed4f80005 Mon Sep 17 00:00:00 2001 From: DoctoDre Date: Tue, 7 Jul 2026 15:42:18 +0200 Subject: [PATCH] docs(steering): add brevity and component-docs steering files --- .kiro/steering/brevity.md | 30 +++++++++++++++++ .kiro/steering/component-docs.md | 56 ++++++++++++++++++++++++++++++++ 2 files changed, 86 insertions(+) create mode 100644 .kiro/steering/brevity.md create mode 100644 .kiro/steering/component-docs.md diff --git a/.kiro/steering/brevity.md b/.kiro/steering/brevity.md new file mode 100644 index 0000000..ac2f558 --- /dev/null +++ b/.kiro/steering/brevity.md @@ -0,0 +1,30 @@ +--- +inclusion: manual +--- + +# Brevity Mode + +Compress all responses. Save tokens. Keep technical accuracy. + +## Rules + +- No filler: skip "I'll", "Let me", "Here's what", "Great question" +- Fragments over sentences +- No markdown headers in short answers +- Code unchanged — never compress code, commands, paths, errors +- Lists over paragraphs +- Max 1-2 lines for status updates +- Skip confirmation of what you're about to do — just do it +- No summarizing what you just did unless asked +- German replies stay German, English stays English + +## Examples + +Bad: "I'll now update the registry file with the new component data and regenerate the architecture overview." +Good: "Registry + overview updated." + +Bad: "Let me check the test results for you. I'll run the full test suite." +Good: *runs tests* + +Bad: "The scan found 19 components across all four contexts. Here's a breakdown of what was discovered..." +Good: "19 components found. All contexts covered." diff --git a/.kiro/steering/component-docs.md b/.kiro/steering/component-docs.md new file mode 100644 index 0000000..015ab17 --- /dev/null +++ b/.kiro/steering/component-docs.md @@ -0,0 +1,56 @@ +--- +inclusion: fileMatch +fileMatchPattern: "**/*" +--- + +# Component Documentation Standard + +## COMPONENT.md Requirement + +Every repo, tool, or subfolder that represents a distinct component in this monorepo MUST have a `COMPONENT.md` file at its root. This is the single source of truth for metadata that cannot be derived from dependency files. + +## When to Create + +- When creating a new project via `ctx-guard create-project` +- When adding a new repo to any context folder +- When onboarding an existing repo into the monorepo + +## Required Format + +```markdown +# Component: {name} + +## Description +{1-2 sentence description of what this component does} + +## Metadata +- **Deployment Target:** {one of: vps-docker, local-mcp-stdio, docker-mcp-http, gitlab-ci, local-cli, local-docker, content-library, file-based, none, planned} +- **Upstream URL:** {URL or "monorepo-internal"} +- **Status:** {active, needs-redo, planned, archived} + +## Interconnections +{bullet list of connections, format: "- **{direction}** {target}: {description}"} +{directions: polls, consumed-by, provides-to, queries, integrates-with, shares-infra, listed-in, references, feeds, sources-from, related-to, used-by, manages} + +## Notes +{any additional operational context — domains, ports, CI details, constraints} +``` + +## Scanner Integration + +The `ctx-guard components scan` command reads COMPONENT.md files to populate registry fields that cannot be derived from dependency files: +- `description` <- from ## Description section +- `deployment-target` <- from Metadata -> Deployment Target +- `upstream-url` <- from Metadata -> Upstream URL +- `status` <- from Metadata -> Status (overrides scanner default of "active") + +## Architecture Overview + +The `docs/architecture-overview.md` is auto-generated from the component registry. It is NOT manually maintained. To update it, run a scan and the overview regenerates with current data including interconnections from COMPONENT.md files. + +## Rules + +1. COMPONENT.md is the source of truth for operational metadata — not requirements.md or design.md +2. Keep it current: update COMPONENT.md when deployment targets, interconnections, or status change +3. Requirements/design specs describe the *planned* state at spec time; COMPONENT.md describes the *current* state in production +4. The architecture overview is derived, never hand-edited