Skip to content

Commit 9e8235e

Browse files
authored
Merge pull request #125 from d-morrison/claude/claude-md-docs-nbeq7n
Refresh CLAUDE.md to current repo state
2 parents 18f0209 + eeb8cb0 commit 9e8235e

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

CLAUDE.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,20 @@ Authoritative style guide: [UCD-SERG Lab Manual](https://ucd-serg.github.io/lab-
1111
## Repository layout
1212

1313
- `index.qmd`, `chapters/`, `appendix-*.qmd` — Quarto source pages
14+
- `references.qmd` — standalone reference page; excluded from the default website
15+
render (`!references.qmd` in `_quarto-website.yml`), so it isn't part of the
16+
normal site build
1417
- `_quarto.yml`, `_quarto-website.yml` — Quarto project + website config
1518
- `_extensions/` — vendored Quarto extensions
1619
- `macros/` — git submodule for shortcode/macro definitions (see `.gitmodules`)
1720
- `R/`, `man/`, `DESCRIPTION`, `NAMESPACE` — the project is also a small R package
1821
- `references.bib` — BibTeX bibliography
19-
- `styles.css` — site styling
22+
- `styles.css` — website styling; `styles-reveal.scss`, `qwt-reveal-toggle.html`, and the `revealjs-*.lua` filters drive the reveal.js slide output
23+
- `assets/`, `images/` — static image and asset files (site pages, docs, CI/PR screenshots)
2024
- `.github/workflows/` — CI workflow definitions
2125
- `.github/scripts/` — helper scripts used by workflows
26+
- `.github/instructions/` — path-scoped Copilot rules that attach by file glob (see `.github/copilot-instructions.md`)
27+
- `CONTRIBUTING.md` — contributor guide
2228
- `_site/`, `_freeze/`, `.quarto/` — build artifacts (do not edit by hand)
2329

2430
## Style conventions
@@ -37,12 +43,14 @@ Mirrors [`.github/copilot-instructions.md`](.github/copilot-instructions.md). Ke
3743
- **Submodules**: `macros/` is the only git submodule (see `.gitmodules`). Run `git submodule update --init --recursive` after cloning.
3844
- **Spell check**: words go in `inst/WORDLIST` (see `.github/workflows/check-spelling.yaml`). Update the wordlist instead of disabling the check.
3945
- **Link check**: tuned in `lychee.toml`; prefer fixing broken links over adding exceptions.
46+
- **Other CI checks**: workflows also verify bibliography DOIs (`check-bibliography-dois.yml`) and flag non-standard characters (`check-non-standard-chars.yaml`). Fix the flagged source rather than relaxing the check.
47+
- **Dependencies**: Dependabot auto-updates the `macros` submodule and GitHub Actions (see `.github/dependabot.yml`); don't bump those by hand unless a PR needs it.
4048

4149
## Pull request expectations
4250

4351
- Keep PRs scoped — bug fixes shouldn't smuggle in refactors.
4452
- Write commit messages and PR descriptions explaining the *why*, not just the *what*.
45-
- Don't bypass CI failures (spell check, link check, lint) — fix the underlying issue.
53+
- Don't bypass CI failures (spell check, link check, lint, bibliography DOIs, non-standard chars) — fix the underlying issue.
4654
- Don't commit `_site/` or `_freeze/` changes unless that is genuinely the intent of the PR.
4755

4856
## Things to avoid

0 commit comments

Comments
 (0)