agentleFS
Sign inStart free
zotoiozotoio/CRUX-Compress/.cursor/rules/docs-sync.md

CRUX-Compress / rules

Cursor rule8 starsChanged 2 months agoMITView on GitHub

When you modify files that affect project functionality or workflows, update the corresponding documentation to keep it in sync.

The file

We split this docs-sync.md into the rules it gives an agent

9 rules. About 0 are common, 8 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When you modify files that affect project functionality or workflows, update the corresponding documentation to keep it in sync.

    line 8
  2. Distinctive:

    Keep formatting consistent with existing style

    line 40
  3. Distinctive:

    Update version numbers, paths, and examples to match actual code

    line 41
  4. Distinctive:

    If adding new workflows or test files, add them to relevant tables/lists

    line 42
  5. Distinctive:

    Keep the CI/CD flow diagram in CONTRIBUTORS.md accurate

    line 43
  6. Very specific:

    Don't update docs for changes to example files in .cursor/rules/example/

    line 47
  7. Distinctive:

    Don't update docs for temporary or generated files

    line 48
  8. Distinctive:

    Don't add speculative features - only document what exists

    line 49
  9. Distinctive:

    Keep documentation concise and actionable

    line 50

≈ “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-sync.md

Documentation Synchronization Rule

When you modify files that affect project functionality or workflows, update the corresponding documentation to keep it in sync.

Documentation Files

Doc FileUpdate When...
README.mdInstallation, usage, or feature changes
CONTRIBUTORS.mdCI/CD workflow, testing, or contribution process changes
web/compress.md/Landing page content, examples, or feature highlights

Trigger Files → Documentation Updates.

README.md Updates

  • install.py - Update installation instructions
  • CRUX.md - Update specification references or examples
  • .cursor/commands/* - Update command usage examples
  • .cursor/skills/*/SKILL.md - Update skill descriptions

CONTRIBUTORS.md Updates

  • .github/workflows/*.yml - Update CI/CD flow diagram and descriptions
  • evals/*.py - Update test structure or running instructions
  • scripts/*.sh - Update development setup if scripts change
  • tests/helpers.bash - Update test helper documentation

web/compress.md/ Updates

  • CRUX.md - Update specification examples on landing page
  • Feature additions - Update feature highlights
  • .cursor/agents/* - Update agent/tooling descriptions

Update Guidelines

  1. Make surgical updates - don't rewrite entire sections
  2. Keep formatting consistent with existing style
  3. Update version numbers, paths, and examples to match actual code
  4. If adding new workflows or test files, add them to relevant tables/lists
  5. Keep the CI/CD flow diagram in CONTRIBUTORS.md accurate

What NOT to Update

  • Don't update docs for changes to example files in .cursor/rules/example/
  • Don't update docs for temporary or generated files
  • Don't add speculative features - only document what exists
  • Keep documentation concise and actionable

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