agentleFS
Sign inStart free
autonomous-aiautonomous-ai/Physical-AI-Operating-System/.cursor/rules/docs-on-code-change.mdc

Physical-AI-Operating-System / rules

Cursor rule552 starsChanged 8 months agoApache-2.0View on GitHub

Update docs (markdown) when code changes

2 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this docs-on-code-change.mdc into the rules it gives an agent

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Update them to match the new code (numbers, flows, endpoints, states, etc.)

    line 18
  2. Distinctive:

    Keep docs accurate — no drift between code and documentation

    line 19

≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
docs-on-code-change.mdc
---
description: Update docs (markdown) when code changes
alwaysApply: true
---

# 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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free