One-click install
npx skills add https://github.com/juice-shop/juice-shop --skill add-reference-juice-shop
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-reference
Source: https://github.com/juice-shop/juice-shop/tree/main/.ai/skills/add-reference
Command: npx skills add https://github.com/juice-shop/juice-shop --skill add-reference-juice-shop

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill prevents references to Juice Shop from becoming outdated, misplaced, or inconsistently formatted by guiding you to add new items into the correct section of REFERENCES.md.

Core Features & Use Cases

  • Automatic categorization between SOLUTIONS.md vs REFERENCES.md: Uses rules to decide whether content is a hacking how-to (SOLUTIONS.md) or a general mention/talk/article (REFERENCES.md).
  • Metadata collection from source URLs: Crawls provided links to capture title, author/speaker, date, and descriptions needed for the correct entry format.
  • Consistent formatting by reference type: Applies the existing per-type templates for blogs, podcasts, lectures, summits, GSoC, conferences, awards, and tool/product usage.
  • Conference ordering and TOC updates: Places entries in the right year section and updates the table of contents when a new year is introduced.

Quick Start

Ask an AI to add the new reference by giving the URL, then verify the extracted title, author/speaker, date, and the chosen type before inserting it into REFERENCES.md using the prescribed format.

Frequently Asked Questions about add-reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new blog or podcast reference to a markdown documentation file?

To format references consistently, the system applies type-specific templates for blogs, podcasts, lectures, and conferences based on extracted metadata. It ensures each entry follows the correct markdown structure and icon for its specific category.

How does metadata extraction work for documentation formatting?

Metadata extraction works by crawling provided source URLs to capture required fields like title, author or speaker, date, and descriptions. This gathered information is then used to automatically populate the correct markdown template for the reference entry.

When do I need to use SOLUTIONS.md instead of REFERENCES.md for content categorization?

You need to use SOLUTIONS.md when the submitted content is a hacking how-to or automation guide, while REFERENCES.md is used for general mentions, articles, talks, and podcasts. The system applies rules to automatically categorize content during insertion.

Can I use this to organize conference and summit mentions by year?

Yes, you can use this to organize conference and summit mentions by placing entries into the correct year-ordered section of the references file. It also updates the table of contents automatically when a new year section is introduced.

What types of Juice Shop references can be formatted with this system?

Supported reference types include podcasts, blogs, lectures, summits, GSoC projects, conferences, awards, and tool or product mentions. Each type receives its specific icon and format template during the markdown insertion process.