agentmods.dev

e2e-doc-sync

A rule that keeps the end-to-end test documentation aligned with the actual tests and scripts. End-to-end tests check complete user workflows across multiple parts of a system.

In plain words
What is it for?
Updating E2E documentation when tests, scripts, workflows, manifests, or Makefile targets change, including keeping the known lane list current.
Why use it?
It prevents the README from listing outdated test lanes, setup steps, prerequisites, compatibility versions, or pass conditions.

Cursor rule for Cursor

214 2d ago A scan 0 tokens original Apache-2.0
View the source file jumpstarter-dev/jumpstarter
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/jumpstarter-dev/jumpstarter/e2e-doc-sync
Clone the repo
git clone --depth 1 https://github.com/jumpstarter-dev/jumpstarter

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 647 The whole file, excluding the scripts and references it only reads on demand.
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.00000 $0.00647
Opus 5 $0.00000 $0.00324
Sonnet 5 $0.00000 $0.00129
Haiku 4.5 $0.00000 $0.00065

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

Security

Grade A, and why

e2e-doc-sync 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/e2e-doc-sync.mdc · 55 lines

How it starts

The opening of the file, as written. The whole thing — 55 lines — stays where its author put it; the contents beside it link to each section on GitHub.

E2E Documentation Synchronization

Keep e2e/README.md synchronized with the current E2E test implementation.

When This Rule Applies

Apply this rule whenever changes touch E2E behavior or execution paths, especially:

  • e2e/test/*.go (new/renamed/removed lanes, labels, or specs)
  • e2e/setup-e2e.sh, e2e/run-e2e.sh, e2e/compat/*.sh
  • e2e/scripts/gen-spec-index.sh (lane grouping list)
  • .github/workflows/e2e.yaml
  • Makefile E2E targets
  • E2E manifests/configs that alter prerequisites or expected checks

Required Updates

When E2E behavior changes, update e2e/README.md in the same PR:

  1. Keep lane names, labels, and source files accurate.
  2. Keep each test row aligned with real prerequisites, steps, and pass checks.
  3. Keep global setup/run prerequisites and CI execution notes current.
  4. Keep compatibility versions and skip conditions in sync with code/workflows.
  5. When adding, renaming, or removing a Ginkgo lane Label(...), update KNOWN_LANES_JSON in e2e/scripts/gen-spec-index.sh in the same PR. Keep the list ordered as the desired Markdown section order. Do not include secondary tags (operator-only, Serial); unknown lane labels silently fall back to first-alphabetic grouping.

Validation Checklist

Recommended Workflow (Every Time)

  1. Run make e2e-spec-index > /tmp/e2e-spec-index.md (no live cluster needed).
  2. Use /tmp/e2e-spec-index.md to verify lane/label/test/source alignment in e2e/README.md.
  3. Update e2e/README.md for any lane, label, prerequisite, step, or pass-check drift found.
  4. Do not commit generated files (/tmp/e2e-spec-index.md or similar scratch output).

Before finishing

  • Verify Describe(... Label(...)) and It("...") names match README entries.
  • Verify new/renamed/removed lane labels are present in KNOWN_LANES_JSON (e2e/scripts/gen-spec-index.sh).
  • Verify commands/flags in README match scripts and tests.
  • Prefer concrete resource names over shorthand aliases.
  • If the PR is docs-only, still cross-check against current e2e/test sources.

Read the full file on GitHub · 55 lines

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 · 55 lines · 0 tokens per session scan A f7c66ede91cd

Subscribe to this mod's changes

e2e-doc-sync is a cursor rule published in the GitHub repository jumpstarter-dev/jumpstarter (214 stars, last pushed 2d ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 647 tokens. 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.

DevOps and cloudTestingWriting and docsautomationboard-farmhardwarehardware-in-the-loophiltesting-framework
Related

Other cursor rules, from other repositories

chiplab

Repository agent instructions for chiplab.

veecle/chiplab · 60 tokens

open-locker-domain

This project implements a digital locker sharing system for lending physical items. Follow these domain-specific conventions.

Open-Locker/Open-Locker · 1,602 tokens

monorepo-architecture

This is a monorepo containing multiple interconnected components for the Open-Locker IoT system.

Open-Locker/Open-Locker · 940 tokens

scramble-openapi

REST API OpenAPI Documentation Guidelines.

Open-Locker/Open-Locker · 6 tokens

adr-decision-required

Require ADRs for architecture-significant decisions.

Open-Locker/Open-Locker · 297 tokens

modbus-integration

The backend does not communicate with Modbus hardware directly. Physical locker control runs in locker-client (Raspberry Pi), which talks to hardware via Modbus and reports status back to the backend over MQTT.

Open-Locker/Open-Locker · 0 tokens