bluetemberg-rules-docs 0.2.0

package/llm/rules/docs-parity.md

@@ -0,0 +1,29 @@
+---
+description: Keep documentation in sync with every user-facing change.
+scope: "**"
+---
+
+# Docs parity
+
+A PR that changes behavior without updating docs is not done.
+
+## What counts as user-facing
+
+- New or removed CLI flags, commands, or options
+- Changes to user-facing workflows (new prompts, removed choices, changed defaults)
+- New or removed public APIs, config options, or schema fields
+- Changes to output behavior or generated artifacts
+
+## Required behavior
+
+When any of the above change:
+
+1. Update `README.md` if the change affects setup, usage, or the feature overview.
+2. Update the relevant documentation page if one covers the changed area.
+3. Include the doc update in the same commit as the code change — not a follow-up.
+
+## When NOT required
+
+- Internal refactors with no behavior change (renaming a variable, extracting a function)
+- Test-only changes
+- Dependency bumps with no API change

package/llm/rules/mermaid-diagrams.md

@@ -0,0 +1,19 @@
+---
+description: Use Mermaid diagrams instead of ASCII art.
+scope: "**"
+---
+
+# Mermaid diagrams
+
+Prefer Mermaid over ASCII art for all diagrams in documentation.
+
+## When to use
+
+- Architecture and flow diagrams in `docs/wiki/`
+- Any diagram that shows relationships, sequences, or data flow
+
+## Patterns
+
+- Use `flowchart TD` or `flowchart LR` for flow/architecture diagrams
+- Use `sequenceDiagram` for request/response flows
+- Use `classDiagram` for type relationships

package/llm/rules/post-edit-diagnostics.md

@@ -0,0 +1,13 @@
+---
+description: Run diagnostics and formatter after editing code files.
+scope: "**"
+---
+
+# Post-edit diagnostics
+
+After each code edit, run file-scoped diagnostics for edited files.
+
+- Run the project formatter on edited files (e.g. `prettier --write`).
+- Treat diagnostics findings from edited files as required follow-up before unrelated work.
+- Preserve file scope by default; do not broaden to whole-project scans unless asked.
+- If multiple files were edited, check each edited file explicitly.

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "bluetemberg-rules-docs",
+  "version": "0.2.0",
+  "description": "Documentation and diagnostics rules for Bluetemberg — docs parity, post-edit diagnostics, Mermaid diagrams.",
+  "keywords": [
+    "bluetemberg-pack",
+    "rules",
+    "docs",
+    "diagnostics"
+  ],
+  "author": "Prototyp Digital",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/prototypdigital/bluetemberg-packs.git"
+  },
+  "files": [
+    "llm/"
+  ]
+}