Skip to content

Commit dc2467f

Browse files
docs: update documentation for repogen (#20)
* docs: ensure CLAUDE.md documentation block * docs: update documentation [doc-maintainer] Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 2e41282 commit dc2467f

3 files changed

Lines changed: 26 additions & 3 deletions

File tree

CLAUDE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code when working with code in this repository.
4+
5+
## Documentation
6+
7+
**update documentation** After any change to source code, update relevant documentation in CLAUDE.md, README.md and the yeti/ folder. A task is not complete without reviewing and updating relevant documentation.
8+
9+
**yeti/ directory** The `yeti/` directory contains documentation written for AI consumption and context enhancement, not primarily for humans. Jobs like `doc-maintainer` and `issue-worker` instruct the AI to read `yeti/OVERVIEW.md` and related files for codebase context before performing tasks. Write content in this directory to be maximally useful to an AI agent understanding the codebase — detailed architecture, patterns, and decision rationale rather than user-facing guides.

yeti/OVERVIEW.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@ repeated compilation during scanning.
137137
2. Whether file sizes match
138138
3. Whether SHA256 checksums match
139139

140-
Used by the RPM and Homebrew generators to skip unnecessary copies during
141-
generation. For existing packages in remote storage (S3/R2), the file may not
142-
exist locally — this is handled gracefully by returning `needsCopy=false`.
140+
Used by all six generators to skip unnecessary copies during generation.
141+
For existing packages in remote storage (S3/R2), the file may not exist
142+
locally — this is handled gracefully by returning `needsCopy=false`.
143143

144144
## Configuration
145145

yeti/ci-cd.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,20 @@ build packages and want to add them to a repository incrementally.
8989
|--------|-------------|
9090
| `packages-added` | Number of packages added to the repository |
9191

92+
## Dependabot
93+
94+
`.github/dependabot.yml` configures automated dependency updates:
95+
96+
- **Ecosystem**: `gomod` — monitors `go.mod` for dependency updates.
97+
- **Schedule**: Weekly checks.
98+
- **Commit prefix**: `deps:` — follows the conventional-commit style used in
99+
this repo (e.g., `perf:`, `fix:`, `docs:`).
100+
- **Labels**: PRs are labeled `dependencies`.
101+
102+
Dependabot respects the `go` directive in `go.mod` and will not propose updates
103+
requiring a newer Go version. Dependabot PRs trigger the `Test` workflow
104+
automatically, providing CI validation before merge.
105+
92106
## Makefile Targets
93107

94108
| Target | Description |

0 commit comments

Comments
 (0)