CLAUDE.md
CLAUDE.mdCLAUDE.mdroot
Quality
66/100
Scores the file, not the repository.Length
665 words
14 headings · 2 code blocksRepository
1.4k
— · pushed 54 days agoLast changed
3 days ago
First indexed 3 days ago.1# CLAUDE.MD -- Academic Project Development with Claude Code23<!-- HOW TO USE: Replace [BRACKETED PLACEHOLDERS] with your project info.4 Customize Beamer environments and CSS classes for your theme.5 Keep this file under ~150 lines — Claude loads it every session.6 See the guide at docs/workflow-guide.html for full documentation. -->78**Project:** [YOUR PROJECT NAME]9**Institution:** [YOUR INSTITUTION]10**Branch:** main1112---1314## Core Principles1516- **Plan first** -- enter plan mode before non-trivial tasks; save plans to `quality_reports/plans/`17- **Verify after** -- compile/render and confirm output at the end of every task18- **Single source of truth** -- Beamer `.tex` is authoritative; Quarto `.qmd` derives from it19- **Quality gates** -- nothing ships below 80/10020- **[LEARN] tags** -- when corrected, save `[LEARN:category] wrong → right` to [MEMORY.md](MEMORY.md)2122Cross-session context lives in [MEMORY.md](MEMORY.md); past plans, specs, and session logs are in [quality_reports/](quality_reports/).2324---2526## Folder Structure2728```29[YOUR-PROJECT]/30├── CLAUDE.MD # This file31├── .claude/ # Rules, skills, agents, hooks32├── Bibliography_base.bib # Centralized bibliography33├── Figures/ # Figures and images34├── Preambles/header.tex # LaTeX headers35├── Slides/ # Beamer .tex files36├── Quarto/ # RevealJS .qmd files + theme37├── docs/ # GitHub Pages (auto-generated)38├── scripts/ # Utility scripts + R code39├── quality_reports/ # Plans, session logs, merge reports, decision records40├── explorations/ # Research sandbox (see rules)41├── templates/ # Session log, quality report templates42└── master_supporting_docs/ # Papers and existing slides43```4445---4647## Commands4849```bash50# LaTeX (3-pass, XeLaTeX only)51cd Slides && TEXINPUTS=../Preambles:$TEXINPUTS xelatex -interaction=nonstopmode file.tex52BIBINPUTS=..:$BIBINPUTS bibtex file53TEXINPUTS=../Preambles:$TEXINPUTS xelatex -interaction=nonstopmode file.tex54TEXINPUTS=../Preambles:$TEXINPUTS xelatex -interaction=nonstopmode file.tex5556# Deploy Quarto to GitHub Pages57./scripts/sync_to_docs.sh LectureN5859# Quality score60python scripts/quality_score.py Quarto/file.qmd6162# Palette sync (LaTeX ↔ SCSS)63./scripts/check-palette-sync.sh6465# Surface-count sync (README ↔ CLAUDE.md ↔ guide ↔ landing page)66./scripts/check-surface-sync.sh67```6869**Palette contract:** color names in `Preambles/header.tex` must match SCSS variables in `Quarto/theme-template.scss`. See [`Preambles/README.md`](Preambles/README.md).7071---7273## Quality Thresholds (advisory)7475| Score | Checkpoint | Meaning |76|-------|------|---------|77| 80 | Commit | Good enough to save |78| 90 | PR | Ready for deployment |79| 95 | Excellence | Aspirational |8081Enforced by `/commit` (halts + asks for override) **and** — once you run `./scripts/install-hooks.sh` — by a real git pre-commit hook (`.githooks/pre-commit`) that runs the surface-sync + quality (≥80) gates on every commit. Bypass sparingly with `SKIP_QUALITY_GATE=1` or `--no-verify`.8283---8485## Skills Quick Reference8687The full table of all skills lives in [README.md](README.md#skills-claudeskills). Most-used, by workflow:8889- **Slides / teaching:** `/create-lecture` `/compile-latex` `/deploy` `/qa-quarto` `/slide-excellence` `/syllabus` `/teach-from-paper` `/scaffold-exercises`90- **Papers / review:** `/review-paper` (`--peer`) `/seven-pass-review` `/respond-to-referees` `/verify-claims` `/proofread` `/humanize` `/submission-disclosures`91- **Data / reproducibility:** `/data-analysis` `/did-event-study` `/simulation-study` `/audit-reproducibility` `/diagnose` `/replication-package` `/capture-environment` `/power-analysis` `/disclosure-check`92- **Research / writing:** `/interview-me` `/lit-review` `/research-ideation` `/preregister` `/grant-proposal` `/data-management-plan`93- **Meta / workflow:** `/commit` `/learn` `/new-skill` `/checkpoint` `/context-status` `/deep-audit` `/coauthor-brief` `/triage-inbox`9495Stata (`/stata-replication`), R packages (`/r-package-check`), TikZ (`/extract-tikz`, `/new-diagram`), and more — see the README for the complete index.9697---9899<!-- CUSTOMIZE: Replace placeholder rows ([your-env], [.your-class]) with your own.100 Delete the rows marked "(example — delete)" once you've added yours. -->101102## Beamer Custom Environments103104| Environment | Effect | Use Case |105| --- | --- | --- |106| `[your-env]` | [Description] | [When to use] |107| `keybox` | Gold background box | Key points *(example — delete)* |108| `definitionbox[Title]` | Blue-bordered titled box | Formal definitions *(example — delete)* |109110## Quarto CSS Classes111112| Class | Effect | Use Case |113| --- | --- | --- |114| `[.your-class]` | [Description] | [When to use] |115| `.smaller` | 85% font | Dense content *(example — delete)* |116| `.positive` | Green bold | Good annotations *(example — delete)* |117118---119120## Current Project State121122| Lecture | Beamer | Quarto | Key Content |123| --- | --- | --- | --- |124| HelloWorld *(sample — delete when ready)* | `HelloWorld.tex` | `HelloWorld.qmd` | Minimal deck to verify setup |125| 1: [Topic] | `Lecture01_Topic.tex` | `Lecture1_Topic.qmd` | [Brief description] |126
Similar configs
Same format, overlapping stack, ranked by quality.
| Repository | Format | Stack | Covers | Score | Changed |
|---|---|---|---|---|---|
| Adit-Jain-srm/NightmareNetCLAUDE.md · 45 | CLAUDE.md | buildtestlint-formatstyle+6 | 100/100 | 3 days ago | |
| nimbalyst/nimbalystpackages/android/CLAUDE.md · 1.4k | CLAUDE.md | setupbuildstylearch+2 | 100/100 | 3 days ago | |
| stacklok/toolhiveCLAUDE.md · 2.0k | CLAUDE.md | buildteststylearch+4 | 100/100 | 3 days ago | |
| dotCMS/corecore-web/CLAUDE.md · 949 | CLAUDE.md | teststylearchtesting-strategy+3 | 100/100 | 3 days ago | |
| microsoft/playwrightCLAUDE.md · 94k | CLAUDE.md | buildtestlint-formatstyle+7 | 100/100 | 3 days ago | |
| filamentphp/filamentCLAUDE.md · 32k | CLAUDE.md | buildtestlint-formatstyle+7 | 100/100 | 3 days ago | |
| livewire/livewireCLAUDE.md · 24k | CLAUDE.md | setupbuildteststyle+4 | 100/100 | 3 days ago | |
| bagisto/bagistoCLAUDE.md · 28k | CLAUDE.md | setupbuildteststyle+5 | 100/100 | 3 days ago |
