# index-sync

The index-sync rule ties changes in guide/ to updates in machine-readable indexes and link checks. Use it when those indexes feed an MCP server or the site search palette.

- rule · `type=rule` · Claude Code, Codex, Cursor, GitHub Copilot, Windsurf (Devin Desktop), Cline · ★ 6529 repo stars
- Author: FlorianBruniaux
- License: CC-BY-SA-4.0 · policy=link-only · description only; the file stays with the author
- Source: https://github.com/FlorianBruniaux/claude-code-ultimate-guide/tree/HEAD/.claude/rules/index-sync.md
- Updated: 2026-10-22
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/rules/index-sync

## What it does

When someone adds a page, section, concept, or tool to `guide/`, the rule calls for corresponding index updates. Add a `deep_dive` entry with an anchor in `machine-readable/reference.yaml`, then copy the change manually to `mcp-server/content/reference.yaml`. A new top-level guide area also affects `llms-full.txt`; the two coverage lists in `llms.txt` must remain identical.

Run `python3 scripts/check-index-coverage.py --check` and `python3 scripts/validate-reference-yaml.py --ci` to check coverage and references. CI runs both checks. Changes to a `deep_dive` entry also require `pnpm build:search` in the landing repository, or the palette keeps its previous entry. The `.claude/hooks/index-sync-reminder.sh` hook warns at the end of a turn; it does not block edits.

## Install

### Claude Code (native platform)

**Manually: put the files in place**
- File: `.claude/rules/index-sync.md` — The paths frontmatter field limits the files

### Codex

**AGENTS.md**
- Codex reads AGENTS.md: paste the rule text there

### Cursor

**Manually: put the files in place**
- File: `.cursor/rules/index-sync.mdc` — Frontmatter: description, globs, alwaysApply

### GitHub Copilot

**Manually: put the files in place**
- File: `.github/instructions/index-sync.instructions.md` — The applyTo field sets which files it applies to

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/rules/index-sync.md`

### Cline

**Manually: put the files in place**
- File: `.clinerules/index-sync.md`

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/FlorianBruniaux/claude-code-ultimate-guide/tree/HEAD/.claude/rules/index-sync.md

## When to use it
- update indexes after adding a guide page
- point a reference entry to a stable anchor
- check guide coverage and resolve broken references
- get a reminder when guide edits lack index updates

## Example prompts
- I added a page to `guide/`; update the indexes required by this rule.
- Check reference anchors and guide coverage after my changes.
- I changed a `deep_dive` entry; tell me what to rebuild for search.

## Similar
- [ctx-index](https://affpapa.org/en/nevibecode/skills/ctx-index.md) — skill · 1200 installs
- [index-repo](https://affpapa.org/en/nevibecode/commands/index-repo.md) — command · ★ 23950 repo stars
- [vector-index-tuning](https://affpapa.org/en/nevibecode/skills/vector-index-tuning.md) — skill · 10700 installs
- [firecrawl-developer-index](https://affpapa.org/en/nevibecode/skills/firecrawl-developer-index.md) — skill · 9900 installs
- [repo-index](https://affpapa.org/en/nevibecode/agents/repo-index.md) — subagent · ★ 23950 repo stars
- [index](https://affpapa.org/en/nevibecode/skills/thoreinstein-index.md) — skill · ★ 102 repo stars

From the same set: [florianbruniaux/claude-code-ultimate-guide](https://affpapa.org/en/nevibecode/by/florianbruniaux/claude-code-ultimate-guide.md) — 45 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
