Get the FREE Ultimate OpenClaw Setup Guide →

skill-with-refs

Scanned
npx machina-cli add skill ggozad/haiku.skills/skill-with-refs --openclaw
Files (1)
SKILL.md
376 B

Skill With References

This skill has additional reference material.

See the reference guide for details.

Source

git clone https://github.com/ggozad/haiku.skills/blob/main/tests/fixtures/skill-with-refs/SKILL.mdView on GitHub

Overview

This skill includes a reference material hub and metadata (author, version, license). It demonstrates linking to a local guide via references/REFERENCE.md and notes compatibility as Requires network access. These references and metadata support governance, traceability, and easier upkeep of the skill.

How This Skill Works

It includes a metadata block in SKILL.md and a link to a local reference guide at references/REFERENCE.md. When the skill is used, users can access the reference material to understand dependencies and usage, while the metadata records authorship, version, license, and tool compatibility. Network access may be required to fetch or verify remote references if applicable.

When to Use It

  • When you need to consult supplementary reference material for guidance.
  • When you want to expose and validate metadata like author, version, and license.
  • When documenting and linking to a local reference guide via references/REFERENCE.md.
  • When network access is available or required to fetch references.
  • When auditing skills for governance and maintainability.

Quick Start

  1. Step 1: Inspect the metadata block in SKILL.md (license, compatibility, author, version).
  2. Step 2: Open references/REFERENCE.md to review the reference material.
  3. Step 3: Run the skill in an environment with network access to verify references load correctly.

Best Practices

  • Keep the references/REFERENCE.md up to date.
  • Validate the references path exists and is accessible.
  • Maintain accurate metadata (author, version, license).
  • Respect license terms and document tool compatibility.
  • Test references loading in both online and offline scenarios when possible.

Example Use Cases

  • A developer checks references/REFERENCE.md before deploying the skill.
  • QA verifies the reference link resolves during a build.
  • The skill is updated with a new author or version and published.
  • The team uses the reference guide to train new users.
  • Compliance teams review the metadata block for licensing.

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers