Skip to content

CLAUDE.md

Latest commit

 

History

History
37 lines (27 loc) · 1.3 KB

CLAUDE.md

File metadata and controls

37 lines (27 loc) · 1.3 KB
Raw

Cooldowns

Documentation site for cooldowns.dev that explains what dependency cooldowns are, why they matter, and how to configure them for various package managers. Includes a helper shell script (cooldowns.sh) that automates checking and configuring cooldowns.

Conventions

  • README.md is the single source of truth for documentation content. docs/index.md includes it via pymdownx.snippets (--8<-- "README.md") and only adds frontmatter. Edit README.md, not docs/index.md.

  • cooldowns.sh must work on both Linux and macOS. Use portable constructs (e.g. awk instead of grep -oP, pure-bash version comparison instead of sort -V).

  • There are two separate changelogs:

    • The changelog in cooldowns.sh records script functionality changes (new tool support, behavior changes). Keep entries to a single line.
    • The changelog in README.md records documentation changes only (new tool docs, changes in configuration). Do not duplicate script-level changes here.

  • Run shellcheck cooldowns.sh after each change to the script.

  • Lint markdown after each change to the documentation files:

    uv run --with mdlint mdlint check

  • Build and validate docs after each change to README.md:

    uv run --with zensical zensical build