Add docs-to-course skill - #1177
Open
IngmarVG-IB wants to merge 3 commits into
Open
Conversation
Transforms documentation (RFCs, API refs, wikis, whitepapers, etc.) into a single-page interactive HTML training course with scroll-based modules, spec-language-to-plain-English side-by-sides, animated concept diagrams, and embedded quizzes. Bundles design-system and interactive-element references and an example output (Axur platform course). Requires the Firecrawl MCP server for URL inputs; works on local files and GitHub repos without it.
SKILL.md was over the 500-line spec recommendation. Extract the MCP setup instructions and the Phase 0 crawl procedure (mapping, URL filtering, batch scrape, credit reference) into a dedicated reference file the agent loads only when a URL input is provided. SKILL.md drops from 575 to 475 lines.
Optional corporate-branding overlay (accent color, nav logo, brand name, actor palette) gated behind an explicit branding phrase or a .brand.json in the working directory. Skill identity — typography, warm palette, layout, voice, semantic colors — stays fixed. Default flow unchanged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds docs-to-course, a skill that turns any documentation — local files, GitHub repos, or live documentation websites — into a stunning, self-contained single-page HTML training course with scroll-based modules, animated visualizations, embedded quizzes, spec ↔ plain-English translation blocks, and spaced retrieval callbacks.
Designed around a documented pedagogy: 80/20 scoping, Bloom-aligned objectives written before content, prediction questions and completion problems for formative assessment, elaborative wrong-answer feedback, and a required synthesis module that returns to the opening scenario.
What's in the submission
skills/docs-to-course/SKILL.mdskills/docs-to-course/references/design-system.mdskills/docs-to-course/references/interactive-elements.mdskills/docs-to-course/references/firecrawl.mdskills/docs-to-course/examples/axur-platform-course.htmlskills/docs-to-course/LICENSEDependencies
references/firecrawl.md.Try it
For corporate-branded output, drop a
.brand.jsonin the working directory or add a phrase like "with our brand" — Phase 2C applies a thin accent + logo skin without overriding the skill's core design identity.Accessibility
Every interactive element ships with keyboard operability, ARIA labels, focus-visible states, reduced-motion fallbacks, drag-and-drop keyboard alternatives, and WCAG 2.1 AA contrast on all default tokens. See the Accessibility section in
references/design-system.md.🤖 Generated with Claude Code