bupkis-docs

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.