Skip to content

v0.51.0 - TypeDoc Category Reorganization (2026-03-28)

What Changed?

This release reorganizes the TypeDoc API documentation structure. The @group-based dual classification is replaced with a single @category system, resulting in a cleaner, user-facing API reference. FlameWright symbols are now publicly exported from the library.

What's New

Main Feature: Unified @category Documentation Structure

What it does: All public symbols are now classified into 9 user-facing categories, replacing the previous dual @group + @category system. The docs/api/README.md index now reflects this structure directly, with no Other section.

Categories:

Category Contents
DataFrame BareFrame, LazyFrame, GroupedFrame, AggFn, RowPredicate, ColumnMapper
FlameFrame FlameFrame, FlameFrameErrors, related types
Flame FlameWright, FlameGuards, FlameGaslets, ensure, assert, explain, getTypeOf
Expression Expression
Convert Primitive, Cell, conversion functions
Logger CategoryLogger, getCategoryLogger, clearLogs, Ember, related types
Gaslets BookArtisan, SheetArtisan, CalendarArtisan, TriggerArtisan, sheet DataFrame functions
Gears ClockSmith, Clock, Counter, JunkPocket, RemnantFlicker
JestLite Expect, Matcher, TestSuite, describe, runTests, all test types

Added

  • FlameWright symbols (FlameWright, FlameGuards, FlameGaslets, Flame, FlameRecord, FlameOptions, ensure, assert, explain, getTypeOf, getValuePreviewOf) are now publicly exported from src/index.ts
  • Developer documentation: docs/dev/prompts.md as comprehensive AI development guide
  • ISSUES.md as replacement for TODO.md with glab workflow reference

Changed

  • TypeDoc @group tags removed from all source files (254 occurrences)
  • TypeDoc categoryOrder consolidated to 9 categories; groupOrder replaced with hideGroupHeadings: true
  • @category values unified: ClockSmith/Counter/JunkPocket → Gears; Book/Sheet/Drive/Calendar/Trigger → Gaslets; Core/Factory/Schema/Guards/Validation → Flame; Types → Logger
  • README.md Features table updated to reflect the 9-category structure
  • CLAUDE.md docstring guidelines updated: @group removed, @category list clarified

Fixed

  • ClockSmith class docstring moved directly before class declaration (was misplaced before ClockSmithOptions interface)
  • RemnantFlicker class docstring added with @category Gears
  • Missing @category added to RowPredicate, ColumnMapper (DataFrame), Primitive, Cell (Convert), and all JestLite interfaces

Is It Safe to Upgrade?

  • Breaking Changes: Yes (minor)
  • Backward Compatible: Yes for runtime behavior

FlameWright symbols (FlameWright, FlameGuards, etc.) are now part of the public API. If your project uses export * from gaslamp, these symbols will now be included. No runtime behavior has changed.

Release Details

  • Date: 2026-03-28
  • Version: v0.51.0
  • gaslamp: 107
  • pilotlamp: 65
  • Files Changed: 74
  • Commits:
    • 55605e19 docs: update README and CLAUDE.md to reflect new category structure
    • 12753b62 feat(api): export FlameWright symbols as public API
    • 72fb3ba0 docs(typedoc): fix class docstring placement to eliminate Other section
    • a8989ba6 docs(typedoc): add missing @category tags to type aliases and interfaces
    • 5414221b docs(typedoc): consolidate @category and remove @group tags
    • 75cb116c build(typedoc): simplify category/group configuration
    • de91c23d docs(nav): add AI-Assisted Development guide to navigation
    • 9785ab3c docs(dev): rewrite prompts.md as comprehensive AI development guide

Known Issues

  • None

Next Steps

  • Review and improve docstrings for FlameWright symbols now that they are publicly documented