setup

Included with Lifetime

$97 forever

Configure doc-sentinel drift detection for a project — detect docs root, watched files, and ignore patterns

Writing & Docs

What this skill does


# doc-sentinel:setup

Interactive setup wizard that creates `.doc-sentinel.json` configuration.

## Phase 1: Detect Project Layout

Run these commands to understand the project:

```bash
# Project structure
ls -la
ls docs/ 2>/dev/null || echo "No docs/ directory"

# Top-level doc files
for f in AGENTS.md ARCHITECTURE.md CLAUDE.md README.md CHANGELOG.md; do
  [ -f "$f" ] && echo "Found: $f"
done

# Check for existing config
cat .doc-sentinel.json 2>/dev/null || echo "No existing config"

# Check for companion plugins
cat .doc-sync.json 2>/dev/null && echo "doc-sync detected"
cat .inkwell.json 2>/dev/null && echo "inkwell detected"
```

## Phase 2: Discover Documentation Files

```bash
# Find all markdown docs
find . -name '*.md' -not -path './node_modules/*' -not -path './.git/*' | head -50

# Find source directories
ls -d src/ lib/ app/ packages/ */ 2>/dev/null | head -20
```

## Phase 3: Configure

Build `.doc-sentinel.json` interactively. Present detected values and ask for confirmation.

### Configuration Schema

```json
{
  "version": 1,
  "docs_root": "docs",
  "watch_files": [
    "AGENTS.md",
    "ARCHITECTURE.md",
    "README.md"
  ],
  "ignore_sources": [
    "*.test.*",
    "*.spec.*",
    "__tests__/**",
    "*.d.ts"
  ],
  "ignore_docs": [],
  "severity": {
    "architecture": "high",
    "agents_md": "high",
    "api_reference": "medium",
    "changelog": "low",
    "readme": "medium"
  }
}
```

**Fields:**

| Field | Type | Default | Purpose |
|-------|------|---------|---------|
| `version` | number | `1` | Config schema version |
| `docs_root` | string | `"docs"` | Primary documentation directory |
| `watch_files` | string[] | `["AGENTS.md", "ARCHITECTURE.md", "README.md"]` | Additional doc files outside docs_root to monitor |
| `ignore_sources` | string[] | `["*.test.*", "*.spec.*", "__tests__/**", "*.d.ts"]` | Source file patterns to skip during drift detection |
| `ignore_docs` | string[] | `[]` | Doc files to exclude from drift checks |
| `severity` | object | see below | Drift severity by doc category |

**Severity levels:** `high` (flag immediately), `medium` (flag at session end), `low` (include in scan reports only).

Default severity:
- `architecture` → high (ARCHITECTURE.md references are critical)
- `agents_md` → high (AGENTS.md/CLAUDE.md references are critical)
- `api_reference` → medium
- `changelog` → low (changelogs are append-only, rarely drift)
- `readme` → medium

## Phase 4: Integration Check

If doc-sync or inkwell config exists, note the relationship:

> doc-sentinel complements doc-sync/inkwell. They write docs; sentinel catches when those docs drift from reality. No conflicts — they use separate queue files.

## Phase 5: Write Configuration

Write `.doc-sentinel.json` to the project root.

Recommend adding to `.gitignore`:

```
.doc-sentinel-drift.json
```

The drift file is ephemeral (session-scoped warnings). The config file should be committed.

## Phase 6: Confirm

Print summary:

```
doc-sentinel configured:
  Docs root:      docs/
  Watched files:  AGENTS.md, ARCHITECTURE.md, README.md
  Ignore sources: *.test.*, *.spec.*, __tests__/**, *.d.ts
  Severity:       2 high, 2 medium, 1 low

Hooks will detect drift on every commit. Run /doc-sentinel:scan for a baseline report.
```

Files: 1

Size: 3.4 KB

Complexity: 11/100

Category: Writing & Docs

Source: https://github.com/dgalarza/claude-code-workflows/tree/main/plugins/doc-sentinel/skills/setup

Related in Writing & Docs

jax-development

Included

Use this skill when the user is writing, debugging, profiling, refactoring, reviewing, benchmarking, parallelising, exporting, or explaining JAX code, or when they mention JAX, jax.numpy, jit, grad, value_and_grad, vmap, scan, lax, random keys, pytrees, jax.Array, sharding, Mesh, PartitionSpec, NamedSharding, pmap, shard_map, Pallas, XLA, StableHLO, checkify, profiler, or the JAX repo. It helps turn NumPy or PyTorch-style code into pure functional JAX, fix tracer/control-flow/shape/PRNG bugs, remove recompiles and host-device syncs, choose transforms and sharding strategies, inspect jaxpr/lowering/IR, and benchmark compiled code correctly.

Writing & Docsscripts

nature-article-writer

Included

Drafts, rewrites, diagnostically critiques, and style-calibrates primary research manuscripts for Nature and Nature Portfolio journals. Use when the user wants a Nature-style title, summary paragraph or abstract, introduction, results, discussion, methods, figure legends, presubmission enquiry, cover letter, reviewer response, or when a scientific draft sounds generic, jargon-heavy, structurally weak, or AI-ish and needs precise, broad-reader-friendly prose without inventing data, analyses, or references. Best for primary research articles and letters rather than reviews or press releases unless explicitly adapting one.

Writing & Docsscripts

deckrd

Included

Document-driven framework that derives requirements, specifications, implementation plans, and executable tasks from goals through structured AI dialogue. Use when user says "write requirements", "create spec", "plan implementation", "derive tasks", "structure this feature", "break down into tasks", or "document this module". Also use for reverse engineering existing code into docs (/deckrd rev). Do NOT use for direct code writing — use /deckrd-coder after tasks are generated. Do NOT use when the user only wants to run or fix existing code without planning.

Writing & Docsscripts

clinical-decision-support

Included

Generate professional clinical decision support (CDS) documents for pharmaceutical and clinical research settings, including patient cohort analyses (biomarker-stratified with outcomes) and treatment recommendation reports (evidence-based guidelines with decision algorithms). Supports GRADE evidence grading, statistical analysis (hazard ratios, survival curves, waterfall plots), biomarker integration, and regulatory compliance. Outputs publication-ready LaTeX/PDF format optimized for drug development, clinical research, and evidence synthesis.

Writing & Docsscripts

handling-sf-data

Included

Salesforce data operations with 130-point scoring. Use this skill to create, update, delete, bulk import/export, generate test data, and clean up org records using sf CLI and anonymous Apex. TRIGGER when: user creates test data, performs bulk import/export, uses sf data CLI commands, needs data factory patterns for Apex tests, or needs to seed/clean records in a Salesforce org. DO NOT TRIGGER when: SOQL query writing only (use querying-soql), Apex test execution (use running-apex-tests), or metadata deployment (use deploying-metadata).

Writing & Docsscripts

accelint-ac-to-playwright

Included

Convert and validate acceptance criteria for Playwright test automation. Use when user asks to (1) review/evaluate/check if AC are ready for automation, (2) assess if AC can be converted as-is, (3) validate AC quality for Playwright, (4) turn AC into tests, (5) generate tests from acceptance criteria, (6) convert .md bullets or .feature Gherkin files to Playwright specs, (7) create test automation from requirements. Handles both bullet-style markdown and Gherkin syntax with JSON test plan generation and validation.

Writing & Docsscripts