What is 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.

Updating E2E documentation when tests, scripts, workflows, manifests, or Makefile targets change, including keeping the known lane list current.

It prevents the README from listing outdated test lanes, setup steps, prerequisites, compatibility versions, or pass conditions.

e2e-doc-sync — Cursor rule for Cursor by 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.

Clone the repo

git clone --depth 1 https://github.com/jumpstarter-dev/jumpstarter

Made for: Cursor.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/rules/jumpstarter-dev/jumpstarter/e2e-doc-sync/github.svg)](https://agentmods.dev/rules/jumpstarter-dev/jumpstarter/e2e-doc-sync)

Your own site

<a href="https://agentmods.dev/rules/jumpstarter-dev/jumpstarter/e2e-doc-sync"><img src="https://agentmods.dev/badge/rules/jumpstarter-dev/jumpstarter/e2e-doc-sync/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/rules/jumpstarter-dev/jumpstarter/e2e-doc-sync"><img src="https://agentmods.dev/badge/rules/jumpstarter-dev/jumpstarter/e2e-doc-sync.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

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. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.00000	$0.00647
Opus 5.5	$0.00000	$0.00259
Sonnet 5.5	$0.00000	$0.00129
Haiku 4.5	$0.00000	$0.00065

Measured 1mo ago against content hash f7c66ede91cd, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 1mo 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:

Keep lane names, labels, and source files accurate.
Keep each test row aligned with real prerequisites, steps, and pass checks.
Keep global setup/run prerequisites and CI execution notes current.
Keep compatibility versions and skip conditions in sync with code/workflows.
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)

Run make e2e-spec-index > /tmp/e2e-spec-index.md (no live cluster needed).
Use /tmp/e2e-spec-index.md to verify lane/label/test/source alignment in e2e/README.md.
Update e2e/README.md for any lane, label, prerequisite, step, or pass-check drift found.
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.

1mo 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 (226 stars, last pushed today), 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.

CI and CD E2E testing Testing board-farm hardware hardware-in-the-loop hil testing-framework

tooling-for-apps

ArchiPy app tooling — uv dependencies, project checks, Behave, Ruff, ty, and pre-commit.

SyntaxArc/archipy-plugin · 313 tokens

test-engineer

When designing test strategy, analysing coverage, or writing tests outside the TDD cycle. Also use when working with CI pipelines or validating changes end-to-end.

ahmadulhoq/agentskel · 31 tokens

qa-automation-engineer

Specialist in test automation infrastructure and E2E testing. Focuses on Playwright, Cypress, CI pipelines, and breaking the system. Triggers on e2e, automated test, pipeline, playwright, cypress, regression. Use with /automation workflow.

MN-Lizard-Team/aiyu-multi-agent · 53 tokens

80-testing-ci-release

Testes Vitest/e2e, fixtures, CI e release.

DarlanPrado/nuxt-zod · 0 tokens

puppeteer

This guide provides opinionated, actionable best practices for writing robust, performant, and maintainable Puppeteer scripts for web scraping, automation, and testing. It emphasizes modern patterns like page.locator() and efficient resource management.

sanjeed5/awesome-cursor-rules-mdc · 1,826 tokens

local-compose-db-lifecycle-for-web-tests

Keep local compose DB lifecycle ready for web tests.

TACC/HPCPerfStats · 9 tokens