add-example

Integrate contributor use-case files into the Examples feature with standardized metadata.

84|32|Updated Jun 9, 2025
One-click install
npx skills add https://github.com/aws-samples/review-and-assessment-powered-by-intelligent-documentation --skill add-example
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-example
Source: https://github.com/aws-samples/review-and-assessment-powered-by-intelligent-documentation/tree/main/.claude/skills/add-example
Command: npx skills add https://github.com/aws-samples/review-and-assessment-powered-by-intelligent-documentation --skill add-example

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pypdfium2, Pillow, reportlab, and includes scripts (resource) components.

What problem does it solve?

This Skill guides contributors through adding new sample use cases to the Examples feature, ensuring consistent structure, metadata, and repository organization.

Core Features & Use Cases

  • Gather use-case details (name, description, language) and required files from contributors.
  • Organize new use-case data under language directories (en/ja) with descriptive naming.
  • Update the frontend metadata JSON with a new entry, including file references and URLs.
  • Generate and manage GitHub raw URLs for all added artifacts.
  • Create or update thumbnail images for use-case representations and prepare translations if new tags are introduced.
  • Validate inputs and provide phase-by-phase guidance from data gathering to thumbnail generation.

Quick Start

Provide the contributor details and sample files, then run the add-example skill to publish the new use case into the repository and UI.

Frequently Asked Questions about add-example

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

FAQPage Schema
How do I add a new sample use case to a GitHub documentation repository?

To add a new sample use case, you provide the contributor details and required files. The skill organizes this data under language directories, validates frontmatter metadata, and updates the frontend JSON to integrate your contribution.

How does thumbnail generation work for new documentation examples?

Thumbnail generation for documentation examples uses Pillow and pypdfium2 to process provided sample files. The skill creates or updates thumbnail images, yielding UI-ready visual representations for the new use case.

Can I include Japanese translations when adding new example metadata?

Yes, you can include Japanese translations. The skill organizes new use-case data under separate English and Japanese language directories and prepares translations for newly introduced tags to maintain bilingual documentation.

What is required to validate frontmatter for contributor-provided use-case files?

Validating frontmatter for contributor files requires mandatory metadata fields within use-case files. The skill enforces this frontmatter validation during data gathering to ensure consistent repository structure before updating frontend metadata.

Does this workflow support generating GitHub raw URLs for added artifacts?

Yes, the workflow supports generating GitHub raw URLs. After organizing use-case files and metadata, the skill automatically generates and manages raw URLs for all added artifacts to ensure correct frontend references.