agentleFS
nzrskynzrsky/zig-skills/CLAUDE.md

zig-skills

CLAUDE.md14 starsChanged 4 months agoMITView on GitHub

A collection of AI coding assistant skills providing verified Zig 0.17.0-dev API documentation (0.16.0 stable plus 0.17 deltas, with migration notes from 0.15.x). This is a documentation-only repository — no build system, no tests, no compiled code. The content prevents LLMs from generating Zig code with deprecated/removed APIs from outdated training data. skills/zig/ is the canonical source. All IDE directories are mirrors. SKILL.md is the entry point. It contains the YAML frontmatter (skill metadata), breaking changes (removed features, I/O rewrite,…

  • In this repository2 other files it gives its agents.

The file

We split this CLAUDE.md into the rules it gives an agent

2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    All content is markdown. There is no build step, linter, or test suite.

    line 40
  2. Very specific:

    Use bash scripts/sync-ide-folders.sh --verify to check all directories are in sync

    line 44

≈ “Common” is an estimate: at least 1 in 5 of the 27,641 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

What This Is

A collection of AI coding assistant skills providing verified Zig 0.17.0-dev API documentation (0.16.0 stable plus 0.17 deltas, with migration notes from 0.15.x). This is a documentation-only repository — no build system, no tests, no compiled code. The content prevents LLMs from generating Zig code with deprecated/removed APIs from outdated training data.

Repository Structure

skills/zig/
  SKILL.md              # Main skill file — frontmatter + all breaking changes, quick fixes, patterns
  references/           # 57 markdown reference files for std library modules, patterns, tooling
.agent/skills/zig/      # IDE mirror — Agent
.cursor/skills/zig/     # IDE mirror — Cursor
.opencode/skills/zig/   # IDE mirror — OpenCode
.codex/skills/zig/      # IDE mirror — Codex
.gemini/skills/zig/     # IDE mirror — Gemini CLI
.continue/skills/zig/   # IDE mirror — Continue
.kilocode/skills/zig/   # IDE mirror — Kilocode
.factory/skills/zig/    # IDE mirror — Factory AI
.adal/skills/zig/       # IDE mirror — AdaL CLI (Sylph AI)
.codebuddy/skills/zig/  # IDE mirror — CodeBuddy
.openclaw/skills/zig/   # IDE mirror — OpenClaw
.pi/skills/zig/         # IDE mirror — Pi Agent
.kiro/steering/         # IDE mirror — Kiro (steering file format)
.claude-plugin/         # Plugin metadata (plugin.json, marketplace.json)
scripts/                # sync-ide-folders.sh

skills/zig/ is the canonical source. All IDE directories are mirrors.

SKILL.md is the entry point. It contains the YAML frontmatter (skill metadata), breaking changes (removed features, I/O rewrite, build system changes, container init), quick fixes table, and an index linking to every reference file.

The references/ files are standalone — each covers one std library module or topic (e.g., std-arraylist.md, std-hashmap.md, patterns.md, production-patterns.md).

Working on This Repo

All content is markdown. There is no build step, linter, or test suite.

When editing:

  • Edit files in skills/zig/ (canonical source), then run bash scripts/sync-ide-folders.sh to propagate to all IDE directories
  • Use bash scripts/sync-ide-folders.sh --verify to check all directories are in sync
  • Code examples in markdown must target Zig 0.17.0-dev (0.16.0 stable patterns still hold; note 0.17 deltas and 0.15.x migrations where relevant) — always show WRONG (old) vs CORRECT (new) patterns for breaking changes
  • SKILL.md frontmatter fields (name, description, license, compatibility, metadata) follow the skills format used by npx skills
  • Reference files are self-contained; each should work standalone without requiring other files to be loaded

Key Conventions

  • Breaking changes follow the pattern: section header, WRONG code block (old API), CORRECT code block (new API), brief explanation
  • The Quick Fixes table in SKILL.md maps compiler error messages to one-line fixes
  • Reference file naming: std-{module}.md for std library, plain names for concepts (patterns.md, comptime.md, language.md)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.