zig-docs

Fetches Zig language and standard library documentation via CLI. Activates when needing Zig API details, std lib function signatures, or language reference content that isn't covered in zig-best-practices.

242 stars

byaiskillstore

View on GitHub Installation ↓

Best use case

zig-docs is best used when you need a repeatable AI agent workflow instead of a one-off prompt. It is especially useful for teams working in multi. Fetches Zig language and standard library documentation via CLI. Activates when needing Zig API details, std lib function signatures, or language reference content that isn't covered in zig-best-practices.

Users should expect a more consistent workflow output, faster repeated execution, and less time spent rewriting prompts from scratch.

Practical example

Example input

Use the "zig-docs" skill to help with this workflow task. Context: Fetches Zig language and standard library documentation via CLI. Activates when needing Zig API details, std lib function signatures, or language reference content that isn't covered in zig-best-practices.

Example output

A structured workflow result with clearer steps, more consistent formatting, and an output that is easier to reuse in the next run.

When to use this skill

Use this skill when you want a reusable workflow rather than writing the same prompt again and again.

When not to use this skill

Do not use this when you only need a one-off answer and do not need a reusable workflow.
Do not use it if you cannot install or maintain the related files, repository context, or supporting tools.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/zig-docs/SKILL.md --create-dirs "https://raw.githubusercontent.com/aiskillstore/marketplace/main/skills/0xbigboss/zig-docs/SKILL.md"

Manual Installation

Download SKILL.md from GitHub
Place it in .claude/skills/zig-docs/SKILL.md inside your project
Restart your AI agent — it will auto-discover the skill

How zig-docs Compares

Feature / Agent	zig-docs	Standard Approach
Platform Support	Not specified	Limited / Varies
Context Awareness	High	Baseline
Installation Complexity	Unknown	N/A

Frequently Asked Questions

What does this skill do?

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# Zig Documentation Fetching

## Instructions

- Use raw GitHub sources for std lib documentation (most reliable)
- Use pandoc for language reference from ziglang.org (works for prose content)
- The std lib HTML docs at ziglang.org are JavaScript-rendered and return empty content; avoid them
- Zig source files contain doc comments (`//!` for module docs, `///` for item docs) that serve as authoritative documentation

## Quick Reference

### Fetch Standard Library Source (Recommended)

Standard library modules are self-documenting. Fetch source directly:

```bash
# Module source with doc comments
curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/<module>.zig"

# Common modules:
curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/log.zig"
curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/mem.zig"
curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/fs.zig"
curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/heap.zig"
curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/debug.zig"
curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/testing.zig"
```

### Fetch Allocator Interface

```bash
curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/mem/Allocator.zig"
```

### Fetch Language Reference (Prose)

```bash
# Full language reference (large, ~500KB of text)
pandoc -f html -t plain "https://ziglang.org/documentation/master/"

# Pipe to head for specific sections
pandoc -f html -t plain "https://ziglang.org/documentation/master/" | head -200
```

### List Standard Library Contents

```bash
# List all std lib modules via GitHub API
curl -sL "https://api.github.com/repos/ziglang/zig/contents/lib/std" | jq -r '.[].name'

# List subdirectory contents
curl -sL "https://api.github.com/repos/ziglang/zig/contents/lib/std/mem" | jq -r '.[].name'
```

### Fetch zig.guide Content

```bash
# Landing page and navigation
pandoc -f html -t plain "https://zig.guide/"
```

## Documentation Sources

| Source | URL Pattern | Notes |
|--------|-------------|-------|
| Std lib source | `raw.githubusercontent.com/ziglang/zig/master/lib/std/<path>` | Most reliable; includes doc comments |
| Language reference | `ziglang.org/documentation/master/` | Use pandoc; prose content |
| zig.guide | `zig.guide/` | Beginner-friendly; use pandoc |
| GitHub API | `api.github.com/repos/ziglang/zig/contents/lib/std` | List directory contents |

## Common Module Paths

| Module | Path |
|--------|------|
| Allocator | `lib/std/mem/Allocator.zig` |
| ArrayList | `lib/std/array_list.zig` |
| HashMap | `lib/std/hash_map.zig` |
| StringHashMap | `lib/std/hash/map.zig` |
| File System | `lib/std/fs.zig` |
| File | `lib/std/fs/File.zig` |
| IO | `lib/std/Io.zig` |
| Logging | `lib/std/log.zig` |
| Testing | `lib/std/testing.zig` |
| Debug | `lib/std/debug.zig` |
| Heap | `lib/std/heap.zig` |
| Build System | `lib/std/Build.zig` |
| JSON | `lib/std/json.zig` |
| HTTP | `lib/std/http.zig` |
| Thread | `lib/std/Thread.zig` |
| Process | `lib/std/process.zig` |

## Version-Specific Documentation

Replace `master` with version tag for stable releases:

```bash
# 0.14.0 release
curl -sL "https://raw.githubusercontent.com/ziglang/zig/0.14.0/lib/std/log.zig"

# Language reference for specific version
pandoc -f html -t plain "https://ziglang.org/documentation/0.14.0/"
```

## Searching Documentation

### Search for specific function/type in std lib

```bash
# Search for function name across std lib
curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/<module>.zig" | grep -A5 "pub fn <name>"

# Example: find allocator.create
curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/mem/Allocator.zig" | grep -A10 "pub fn create"
```

### Extract doc comments

```bash
# Module-level docs (//!)
curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/log.zig" | grep "^//!"

# Function/type docs (///)
curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/mem/Allocator.zig" | grep -B1 "pub fn" | grep "///"
```

## Troubleshooting

**Empty content from ziglang.org/documentation/master/std/:**
- The std lib HTML docs are JavaScript-rendered; use raw GitHub instead

**pandoc fails:**
- Some pages require JavaScript; fall back to curl + raw GitHub
- Check URL is correct (no trailing slash issues)

**Rate limiting on GitHub API:**
- Use raw.githubusercontent.com URLs directly instead of API
- Cache frequently accessed content locally

## References

- Language Reference: https://ziglang.org/documentation/master/
- Standard Library Source: https://github.com/ziglang/zig/tree/master/lib/std
- Zig Guide: https://zig.guide/
- Release Tags: https://github.com/ziglang/zig/tags

Related Skills

github-actions-docs

242

from aiskillstore/marketplace

Use when users ask how to write, explain, customize, migrate, secure, or troubleshoot GitHub Actions workflows, workflow syntax, triggers, matrices, runners, reusable workflows, artifacts, caching, secrets, OIDC, deployments, custom actions, or Actions Runner Controller, especially when they need official GitHub documentation, exact links, or docs-grounded YAML guidance.

docs-architect

242

from aiskillstore/marketplace

Creates comprehensive technical documentation from existing codebases. Analyzes architecture, design patterns, and implementation details to produce long-form technical manuals and ebooks. Use PROACTIVELY for system documentation, architecture guides, or technical deep-dives.

docstring

242

from aiskillstore/marketplace

Write docstrings for PyTorch functions and methods following PyTorch conventions. Use when writing or updating docstrings in PyTorch code.

docs-write

242

from aiskillstore/marketplace

Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).

docs-review

242

from aiskillstore/marketplace

Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.