Skip to content

docs: add CLAUDE.md with topic guides under .claude/resources#452

Merged
sanketsudake merged 1 commit into
masterfrom
claude-md-docs
Jun 7, 2026
Merged

docs: add CLAUDE.md with topic guides under .claude/resources#452
sanketsudake merged 1 commit into
masterfrom
claude-md-docs

Conversation

@sanketsudake

Copy link
Copy Markdown
Member

What

Adds contributor/agent documentation for the repo, structured as a slim root CLAUDE.md (auto-loaded by Claude Code) with progressive-disclosure topic guides under .claude/resources/:

File Covers
CLAUDE.md Repo overview, quick commands, hard rules, pointers to the guides
build-and-images.md rules.mk semantics (the DOCKER_FLAGS=--push default!), the three places build args must stay in sync, local build recipes, build-context constraints
runtime-architecture.md The specialize protocol (v1/v2), per-language functionName semantics (they all differ!), builder contract, runtime notes
ci.md E2e vs build-only jobs, the four CI gotchas that caused real failures this cycle, test harness usage, debugging tips
release-process.md envconfig-driven releases, release_check.py GHCR-gate semantics + reconcile mode, multi-PR-train conflict resolution, version pin locations, fission.io sync
environment-notes.md Per-env quirks and history: jvm's source-built fission-java-core, ruby's Rack 2.2 pin, PHP 8.3 extension rules, amd64-only tensorflow, frozen legacy dotnet, etc.

Why

This captures everything non-obvious learned during the June 2026 dependency-update series (#436#446, #450#451) — the things that cost real debugging time: the e2e tests silently testing stale Docker Hub images, workflow-only PRs exercising nothing, the GHCR token semantics for brand-new packages, the environments.json regeneration rule, and per-environment landmines.

Verification

  • Docs-only change; no env paths touched, so only the check job runs.
  • Every concrete claim was fact-checked against the current tree (rules.mk defaults, workflow job shapes, action contents, release_check.py behavior, server endpoints, Dockerfile details); three imprecisions found in review were corrected before this PR.

🤖 Generated with Claude Code

Adds contributor/agent documentation distilled from the June 2026
dependency-update series (#436-#446, #450-#451):

- CLAUDE.md: repo overview, quick commands, hard rules, pointers
- build-and-images.md: rules.mk semantics (DOCKER_FLAGS=--push
  default, target-specific PLATFORMS), the three places build args
  must stay in sync, local build recipes, build-context constraints
- runtime-architecture.md: the specialize protocol, per-language
  functionName semantics, builder contract, language runtime notes
- ci.md: e2e vs build-only jobs, the four CI gotchas that caused
  real failures (stale utils.sh image defaults, unexercised
  workflow-only PRs, substring filter gates, broken action pins),
  test harness usage and debugging tips
- release-process.md: envconfig-driven releases, release_check.py
  GHCR gate semantics and reconcile mode, multi-PR train conflict
  resolution, Fission version pin locations, fission.io sync
- environment-notes.md: per-env quirks and history (jvm's
  source-built fission-java-core, ruby Rack 2.2 pin, php 8.3
  extension rules, amd64-only tensorflow, frozen legacy dotnet)

All factual claims fact-checked against the current tree.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@sanketsudake sanketsudake merged commit c3cda08 into master Jun 7, 2026
15 checks passed
@sanketsudake sanketsudake deleted the claude-md-docs branch June 7, 2026 02:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants