docs-on-code-change

A documentation rule that keeps Markdown guides in sync with code changes. It covers behavior, architecture, APIs, configuration, startup, and related project areas.

In plain words
What is it for?
Use it when adding features, refactoring, changing APIs or configuration, or altering startup and device workflows. It helps update the right files with current numbers, flows, endpoints, and states.
Why use it?
It prevents documentation from describing old behavior after the software changes. It also points developers to the relevant Vietnamese documentation files.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/autonomous-ai/autonomous-os/docs-on-code-change
Clone the repo
git clone --depth 1 https://github.com/autonomous-ai/autonomous-os

Made for: Cursor.

Per session 339 This file is loaded in full into every session.
When invoked 339 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00339 $0.00339
Opus 5 $0.00169 $0.00169
Sonnet 5 $0.00068 $0.00068
Haiku 4.5 $0.00034 $0.00034

Measured 2d ago against content hash 6953a9268aef, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docs-on-code-change scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/docs-on-code-change.mdc · 39 lines

What it actually says

Docs on Code Change

Whenever you write or change code that affects behavior, architecture, or APIs, you must update the relevant documentation in docs/.

Scope

  • New features, refactors, API changes, config changes, startup flow changes
  • Applies to: internal/, server/, domain/, scripts/, web/, bootstrap/

Actions

  1. Identify which docs/*_vi.md files are impacted
  2. Update them to match the new code (numbers, flows, endpoints, states, etc.)
  3. Keep docs accurate — no drift between code and documentation

Doc Files

Code area Docs to update
lamp-server, API, startup lamp-server_vi.md
LED, effects, states, animations led-control_vi.md
Setup flow, provisioning setup-flow_vi.md
Web UI, configuration pages web-ui_vi.md
Flow Monitor (pipeline SVG, flow logs) flow-monitor_vi.md (and docs/flow-monitor.md)
Overall structure overview_vi.md
MQTT, dispatch, publish mqtt_vi.md
bootstrap, OTA bootstrap-server_vi.md

Convention

  • Vietnamese docs: *_vi.md (e.g. lamp-server_vi.md)
  • English vision/design: keep as-is unless code explicitly changes behavior
  • 100% accurate: numbers, names, flows must match code
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 39 lines · 339 tokens per session scan A 6953a9268aef

Subscribe to this mod's changes

docs-on-code-change is a cursor rule published in the GitHub repository autonomous-ai/autonomous-os (256 stars, last pushed 3d ago), licensed Apache-2.0. It adds 339 tokens to every session, about $0.0017 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.