bupkis-docs

Generate semantic metadata and redirects for Bupkis TypeDoc documentation.

8|1|Updated Aug 15, 2025
One-click install
npx skills add https://github.com/boneskull/bupkis --skill bupkis-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bupkis-docs
Source: https://github.com/boneskull/bupkis/tree/main/.claude/skills/bupkis-docs
Command: npx skills add https://github.com/boneskull/bupkis --skill bupkis-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires typedoc, serve, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the complex process of creating and maintaining documentation for the Bupkis project, especially concerning TypeDoc sites, custom JSDoc tags, and dynamic redirects. It eliminates manual errors, ensures consistency, and automates validation, allowing developers to focus on coding rather than tedious documentation upkeep.

Core Features & Use Cases

  • Automated TypeDoc Site Generation: Builds the Bupkis documentation site from source code JSDoc comments and hand-written pages using TypeDoc.
  • Custom JSDoc Tag Processing: Understands and processes @bupkisAnchor, @bupkisAssertionCategory, and @bupkisRedirect tags to generate accurate documentation and redirects.
  • Dynamic Redirect Generation & Validation: Automatically creates and validates URL redirects for assertion documentation, ensuring user-friendly and functional links.
  • Media File Management: Handles the copying of media assets from site/media/ to the generated documentation output.
  • Integration with Playwright: Provides a script to validate redirects end-to-end using Playwright MCP, ensuring all links work correctly in a browser environment.
  • Use Case: When you add a new assertion to Bupkis, use this Skill to ensure its JSDoc comments are correctly formatted, the documentation is rebuilt, and all associated redirects are validated, guaranteeing a seamless user experience.

Quick Start

Use the bupkis-docs skill to add documentation for the new 'to be empty' assertion, ensuring all JSDoc tags and redirects are correctly configured.

Frequently Asked Questions about bupkis-docs

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

FAQPage Schema
How do I automate TypeDoc documentation generation with custom JSDoc tags?

TypeDoc documentation generation can be automated by processing custom JSDoc tags like @bupkisAnchor, @bupkisAssertionCategory, and @bupkisRedirect within your source code. This Skill generates precise semantic metadata from these tags, rebuilds your documentation site, and validates all associated redirects automatically, eliminating manual errors and ensuring consistency across your API reference.

Can I automatically generate and validate URL redirects for API documentation?

Yes. This Skill automatically creates and validates URL redirects for assertion documentation using custom JSDoc tags, then end-to-end validates them with Playwright to ensure all links work correctly in a browser environment. This eliminates manual redirect configuration and broken-link issues in your TypeDoc site.

What's the best way to maintain TypeDoc documentation and media assets in a build pipeline?

Integrate documentation automation into your build pipeline by processing JSDoc comments and custom tags to generate the TypeDoc site, copy media assets from source to output, and validate redirects. This Skill handles the entire workflow, ensuring your documentation stays synchronized with code changes and passes validation before deployment.

Do I need to manually create redirects when documenting new assertions?

No. When you add new assertions with properly formatted JSDoc comments and @bupkisRedirect tags, this Skill automatically generates the corresponding redirects and validates them. This ensures seamless documentation updates without manual redirect management or broken links.

How do I validate that my documentation build is correct?

This Skill provides build validation workflows that check TypeDoc generation, custom JSDoc tag processing, redirect accuracy, and media file handling. It generates machine-readable test inputs and uses Playwright to validate redirects end-to-end, catching errors before your documentation goes live.