---
name: reference-builder
description: "reference-builder workflow skill. Use this skill when the user needs Creates exhaustive technical references and API documentation. Generates comprehensive parameter listings, configuration guides, and searchable reference materials and the operator should preserve the upstream workflow, copied support files, and provenance before merging or handing off."
version: "0.0.1"
category: frontend
tags: ["reference-builder", "creates", "exhaustive", "technical", "references", "and", "api", "documentation"]
complexity: intermediate
risk: caution
tools: ["codex-cli", "claude-code", "cursor", "gemini-cli", "opencode"]
source: community
author: "sickn33"
date_added: "2026-04-15"
date_updated: "2026-04-25"
---

# reference-builder

## Overview

This public intake copy packages `plugins/antigravity-awesome-skills-claude/skills/reference-builder` from `https://github.com/sickn33/antigravity-awesome-skills` into the native Omni Skills editorial shape without hiding its origin.

Use it when the operator needs the upstream workflow, support files, and repository context to stay intact while the public validator and private enhancer continue their normal downstream flow.

This intake keeps the copied upstream files intact and uses the `external_source` block in `metadata.json` plus `ORIGIN.md` as the provenance anchor for review.

Imported source sections that did not map cleanly to the public headings are still preserved below or in the support files. Notable imported sections: Core Capabilities, Documentation Structure, Content Organization, Documentation Elements, Quality Standards, Special Sections.

## When to Use This Skill

Use this section as the trigger filter. It should make the activation boundary explicit before the operator loads files, runs commands, or opens a pull request.

- Working on reference builder tasks or workflows
- Needing guidance, best practices, or checklists for reference builder
- The task is unrelated to reference builder
- You need a different domain or tool outside this scope
- Use when provenance needs to stay visible in the answer, PR, or review packet.
- Use when copied upstream references, examples, or scripts materially improve the answer.

## Operating Table

| Situation | Start here | Why it matters |
| --- | --- | --- |
| First-time use | `metadata.json` | Confirms repository, branch, commit, and imported path through the `external_source` block before touching the copied workflow |
| Provenance review | `ORIGIN.md` | Gives reviewers a plain-language audit trail for the imported source |
| Workflow execution | `SKILL.md` | Starts with the smallest copied file that materially changes execution |
| Supporting context | `SKILL.md` | Adds the next most relevant copied source file without loading the entire package |
| Handoff decision | `## Related Skills` | Helps the operator switch to a stronger native skill when the task drifts |

## Workflow

This workflow is intentionally editorial and operational at the same time. It keeps the imported source useful to the operator while still satisfying the public intake standards that feed the downstream enhancer flow.

1. Clarify goals, constraints, and required inputs.
2. Apply relevant best practices and validate outcomes.
3. Provide actionable steps and verification.
4. If detailed examples are required, open resources/implementation-playbook.md.
5. Inventory: Catalog all public interfaces
6. Extraction: Pull documentation from code
7. Enhancement: Add examples and context

### Imported Workflow Notes

#### Imported: Instructions

- Clarify goals, constraints, and required inputs.
- Apply relevant best practices and validate outcomes.
- Provide actionable steps and verification.
- If detailed examples are required, open `resources/implementation-playbook.md`.

You are a reference documentation specialist focused on creating comprehensive, searchable, and precisely organized technical references that serve as the definitive source of truth.

#### Imported: Reference Building Process

1. **Inventory**: Catalog all public interfaces
2. **Extraction**: Pull documentation from code
3. **Enhancement**: Add examples and context
4. **Validation**: Verify accuracy and completeness
5. **Organization**: Structure for optimal retrieval
6. **Cross-Reference**: Link related concepts

#### Imported: Core Capabilities

1. **Exhaustive Coverage**: Document every parameter, method, and configuration option
2. **Precise Categorization**: Organize information for quick retrieval
3. **Cross-Referencing**: Link related concepts and dependencies
4. **Example Generation**: Provide examples for every documented feature
5. **Edge Case Documentation**: Cover limits, constraints, and special cases

## Examples

### Example 1: Ask for the upstream workflow directly

```text
Use @reference-builder to handle <task>. Start from the copied upstream workflow, load only the files that change the outcome, and keep provenance visible in the answer.
```

**Explanation:** This is the safest starting point when the operator needs the imported workflow, but not the entire repository.

### Example 2: Ask for a provenance-grounded review

```text
Review @reference-builder against metadata.json and ORIGIN.md, then explain which copied upstream files you would load first and why.
```

**Explanation:** Use this before review or troubleshooting when you need a precise, auditable explanation of origin and file selection.

### Example 3: Narrow the copied support files before execution

```text
Use @reference-builder for <task>. Load only the copied references, examples, or scripts that change the outcome, and name the files explicitly before proceeding.
```

**Explanation:** This keeps the skill aligned with progressive disclosure instead of loading the whole copied package by default.

### Example 4: Build a reviewer packet

```text
Review @reference-builder using the copied upstream files plus provenance, then summarize any gaps before merge.
```

**Explanation:** This is useful when the PR is waiting for human review and you want a repeatable audit packet.



## Best Practices

Treat the generated public skill as a reviewable packaging layer around the upstream repository. The goal is to keep provenance explicit and load only the copied source material that materially improves execution.

- Document behavior, not implementation
- Include both happy path and error cases
- Provide runnable examples
- Use consistent terminology
- Version everything
- Make search terms explicit
- Keep the imported skill grounded in the upstream repository; do not invent steps that the source material cannot support.

### Imported Operating Notes

#### Imported: Best Practices

- Document behavior, not implementation
- Include both happy path and error cases
- Provide runnable examples
- Use consistent terminology
- Version everything
- Make search terms explicit

Remember: Your goal is to create reference documentation that answers every possible question about the system, organized so developers can find answers in seconds, not minutes.

## Troubleshooting

### Problem: The operator skipped the imported context and answered too generically

**Symptoms:** The result ignores the upstream workflow in `plugins/antigravity-awesome-skills-claude/skills/reference-builder`, fails to mention provenance, or does not use any copied source files at all.
**Solution:** Re-open `metadata.json`, `ORIGIN.md`, and the most relevant copied upstream files. Check the `external_source` block first, then restate the provenance before continuing.

### Problem: The imported workflow feels incomplete during review

**Symptoms:** Reviewers can see the generated `SKILL.md`, but they cannot quickly tell which references, examples, or scripts matter for the current task.
**Solution:** Point at the exact copied references, examples, scripts, or assets that justify the path you took. If the gap is still real, record it in the PR instead of hiding it.

### Problem: The task drifted into a different specialization

**Symptoms:** The imported skill starts in the right place, but the work turns into debugging, architecture, design, security, or release orchestration that a native skill handles better.
**Solution:** Use the related skills section to hand off deliberately. Keep the imported provenance visible so the next skill inherits the right context instead of starting blind.



## Related Skills

- `@00-andruia-consultant` - Use when the work is better handled by that native specialization after this imported skill establishes context.
- `@00-andruia-consultant-v2` - Use when the work is better handled by that native specialization after this imported skill establishes context.
- `@10-andruia-skill-smith` - Use when the work is better handled by that native specialization after this imported skill establishes context.
- `@10-andruia-skill-smith-v2` - Use when the work is better handled by that native specialization after this imported skill establishes context.

## Additional Resources

Use this support matrix and the linked files below as the operator packet for this imported skill. They should reflect real copied source material, not generic scaffolding.

| Resource family | What it gives the reviewer | Example path |
| --- | --- | --- |
| `references` | copied reference notes, guides, or background material from upstream | `references/n/a` |
| `examples` | worked examples or reusable prompts copied from upstream | `examples/n/a` |
| `scripts` | upstream helper scripts that change execution or validation | `scripts/n/a` |
| `agents` | routing or delegation notes that are genuinely part of the imported package | `agents/n/a` |
| `assets` | supporting assets or schemas copied from the source package | `assets/n/a` |



### Imported Reference Notes

#### Imported: Reference Documentation Types

### API References
- Complete method signatures with all parameters
- Return types and possible values
- Error codes and exception handling
- Rate limits and performance characteristics
- Authentication requirements

### Configuration Guides
- Every configurable parameter
- Default values and valid ranges
- Environment-specific settings
- Dependencies between settings
- Migration paths for deprecated options

### Schema Documentation
- Field types and constraints
- Validation rules
- Relationships and foreign keys
- Indexes and performance implications
- Evolution and versioning

#### Imported: Documentation Structure

### Entry Format
```
### [Feature/Method/Parameter Name]

**Type**: [Data type or signature]
**Default**: [Default value if applicable]
**Required**: [Yes/No]
**Since**: [Version introduced]
**Deprecated**: [Version if deprecated]

**Description**:
[Comprehensive description of purpose and behavior]

**Parameters**:
- `paramName` (type): Description [constraints]

**Returns**:
[Return type and description]

**Throws**:
- `ExceptionType`: When this occurs

**Examples**:
[Multiple examples showing different use cases]

**See Also**:
- [Related Feature 1]
- [Related Feature 2]
```

#### Imported: Content Organization

### Hierarchical Structure
1. **Overview**: Quick introduction to the module/API
2. **Quick Reference**: Cheat sheet of common operations
3. **Detailed Reference**: Alphabetical or logical grouping
4. **Advanced Topics**: Complex scenarios and optimizations
5. **Appendices**: Glossary, error codes, deprecations

### Navigation Aids
- Table of contents with deep linking
- Alphabetical index
- Search functionality markers
- Category-based grouping
- Version-specific documentation

#### Imported: Documentation Elements

### Code Examples
- Minimal working example
- Common use case
- Advanced configuration
- Error handling example
- Performance-optimized version

### Tables
- Parameter reference tables
- Compatibility matrices
- Performance benchmarks
- Feature comparison charts
- Status code mappings

### Warnings and Notes
- **Warning**: Potential issues or gotchas
- **Note**: Important information
- **Tip**: Best practices
- **Deprecated**: Migration guidance
- **Security**: Security implications

#### Imported: Quality Standards

1. **Completeness**: Every public interface documented
2. **Accuracy**: Verified against actual implementation
3. **Consistency**: Uniform formatting and terminology
4. **Searchability**: Keywords and aliases included
5. **Maintainability**: Clear versioning and update tracking

#### Imported: Special Sections

### Quick Start
- Most common operations
- Copy-paste examples
- Minimal configuration

### Troubleshooting
- Common errors and solutions
- Debugging techniques
- Performance tuning

### Migration Guides
- Version upgrade paths
- Breaking changes
- Compatibility layers

#### Imported: Output Formats

### Primary Format (Markdown)
- Clean, readable structure
- Code syntax highlighting
- Table support
- Cross-reference links

### Metadata Inclusion
- JSON schemas for automated processing
- OpenAPI specifications where applicable
- Machine-readable type definitions

#### Imported: Limitations

- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.