new-module

Scaffold a complete training module structure with docs layout and navigation files.

261|325|Updated Aug 27, 2020
One-click install
npx skills add https://github.com/nextflow-io/training --skill new-module
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: new-module
Source: https://github.com/nextflow-io/training/tree/main/.claude/skills/new-module
Command: npx skills add https://github.com/nextflow-io/training --skill new-module

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams bootstrap a complete training module structure within a Nextflow training repository, ensuring consistent conventions and a fast start for new courses.

Core Features & Use Cases

  • Module scaffolding: Creates docs/[module_name]/ with index.md (overview with learning objectives), 00_orientation.md, 01_first_topic.md, survey.md, next_steps.md, and supporting folders img/ and solutions/.
  • Convention adherence: Enforces repository conventions for file layout, navigation, and documentation style.
  • Use Case: When starting a new course like 'Advanced Pipelines', this Skill generates the full module skeleton ready for content authors.

Quick Start

Run the module-scaffold command by providing:

  • module_name
  • module_location (under docs/)
  • module_title for display The tool will create the complete directory structure and initial files.

Frequently Asked Questions about new-module

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

FAQPage Schema
How do I scaffold a training module structure in a repository?

Scaffolding a training module structure creates a standardized directory layout under docs/[module_name] with index, orientation, lessons, surveys, and navigation files to ensure consistent repository conventions for new courses.

What files are needed to bootstrap a new course documentation layout?

Bootstrapping a new course documentation layout requires index.md for learning objectives, 00_orientation.md, lesson files like 01_first_topic.md, survey.md, next_steps.md, alongside supporting img/ and solutions/ folders.

How do I maintain repository conventions when creating educational docs?

Maintaining repository conventions when creating educational docs requires enforcing a standardized file layout, navigation structure, and documentation style across all training modules to ensure consistency for content authors.

Can I generate a complete training module skeleton automatically?

Generating a complete training module skeleton automatically requires providing a module_name, module_location under docs/, and module_title to create the full directory structure and initial files for content authors.