living-documentation 7.46.0 → 7.47.0

package/dist/starting-doc/AI/project-instructions.md

@@ -0,0 +1,78 @@
+# Project AI Instructions
+
+This file is the shared operating guide for AI assistants working on this project.
+
+Keep this file short, concrete, and project-specific. `AGENTS.md` and `CLAUDE.md` should point here instead of duplicating the same instructions.
+
+## Startup Routine
+
+Before making changes:
+
+1. Read this file.
+2. Read `memory/MEMORY.md` and load the relevant memory files listed there.
+3. Read every rule in `DOCS_FOLDER/AI/rules/*.md`.
+4. To understand existing decisions, inspect ADR frontmatter first: read only `description` and `tags`, then open the full ADR only when relevant.
+
+Replace `DOCS_FOLDER` with the real documentation folder path used by this project, for example `documentation` or `docs`.
+
+## AI Rules
+
+Rules live in `DOCS_FOLDER/AI/rules/*.md`.
+
+Each rule uses frontmatter:
+
+- `id` - stable rule identifier
+- `title` - short human-readable name
+- `severity` - `guideline`, `warning`, or `required`
+- `description` - concise summary
+- `tags` - themes used for discovery
+- `appliesTo` - file globs describing where the rule applies
+
+Apply every rule whose `appliesTo` patterns match files you touch. If a rule conflicts with the user request or another project instruction, state the conflict explicitly before proceeding.
+
+## ADRs
+
+ADRs are the durable record of important decisions.
+
+When you need to understand why something exists:
+
+1. List ADR files.
+2. Read only frontmatter `description` and `tags`.
+3. Open the full ADR only when it is relevant to the current task.
+4. If you make or change an important decision, create or update an ADR.
+
+## Continuous Documentation
+
+At the end of every coherent feature or meaningful refactor, update the durable documentation autonomously when the change created knowledge that future work must preserve.
+
+Do create or update an ADR when the feature:
+
+- changes an architecture boundary, public contract, storage format, protocol, or workflow;
+- introduces a convention that future changes must follow;
+- resolves a trade-off that would be hard to infer from code alone;
+- supersedes or invalidates a previous decision.
+
+Do not create ADRs for trivial fixes, mechanical renames, formatting-only changes, or implementation details that are obvious from the changed code.
+
+When you create or update an ADR or another durable documentation page, attach source-file metadata so Living Documentation can show reliability drift:
+
+1. Link the document to the source files that prove or implement what it describes.
+2. After the document is correct, refresh/re-baseline its metadata hashes.
+3. If MCP tools are available, prefer `add_metadata` and `refresh_metadata`.
+4. If metadata cannot be updated from the current environment, state that explicitly and list the source files that should be attached.
+
+## Memory
+
+Memory files live in the project under `memory/`.
+
+Do not store project memory in a tool-specific global folder if the user expects project-local memory. Update `memory/MEMORY.md` whenever you add or remove memory files.
+
+## Verification
+
+Before finishing a task, run the smallest useful verification:
+
+- build command if build files or typed code changed
+- focused tests when behavior changed
+- lint or formatting command if this project has one
+
+If a verification command cannot be run, say why.

package/dist/starting-doc/AI/rules/no-magic-numbers.md

@@ -0,0 +1,18 @@
+---
+id: no-magic-numbers
+title: Avoid magic numbers
+severity: warning
+description: Numeric values with domain meaning must be named constants instead of repeated raw literals.
+tags: ["code-quality", "maintainability"]
+appliesTo: ["src/**/*.ts", "src/frontend/**/*.js"]
+---
+
+Numeric values with domain meaning should be named where they are introduced.
+
+Prefer a constant whose name explains the intent:
+
+```ts
+const DEFAULT_CUSTOM_SHAPE_SIZE = 65;
+```
+
+Avoid repeating raw values in code when the value carries product, rendering, sizing, timing, or protocol meaning.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "living-documentation",
-  "version": "7.46.0",
+  "version": "7.47.0",
   "description": "A CLI tool that serves a local Markdown documentation viewer",
   "main": "dist/src/server.js",
   "bin": {

package/dist/starting-doc/.annotations.json

@@ -1 +0,0 @@
-{}