initial typedoc exploring

[alexphelps]

Initial effort to add inline documentation for enhancer classes and interfaces for documentation with typedoc.

To run docs on your local, run with npm run docs:dev

[kilo-code-bot]

Code Review Summary

Status: 1 Issue Found | Recommendation: Address before merge

Overview

Severity	Count
CRITICAL	1

Issue Details (click to expand)

CRITICAL

File	Line	Issue
typedoc.json	39	"skipErrorChecking": false combined with "treatWarningsAsErrors": true will cause the docs build to fail on any warning. The false default is already falsy, making this line redundant while the config remains dangerously strict. Either set skipErrorChecking: true or remove treatWarningsAsErrors until the codebase is fully documented.

Changes Since Last Review

• src/utils/logger.ts - class-level doc block added with JSDoc + TSDoc
• src/utils/events.ts - class-level doc block added with JSDoc + TSDoc + usage example
• src/types/campaign.ts - doc blocks added to Campaign, VariantAttribute, ProductVariant, Product, Package, ShippingOption
• src/types/global.ts - extensive doc block additions throughout the file
• typedoc.json - added entryPoints entries for DisplayEnhancerTypes.ts and projectDocuments for expressions.generated.md; removed FormatType from intentionallyNotExported; issue persists at line 39

Other Observations (not in diff)

Issues found in unchanged code that cannot receive inline comments:

File	Line	Issue
test-results/.last-run.json	new	Generated test artifact — should not be committed; add to .gitignore
typedoc.html.json	new	Generated config for HTML docs output — likely should not be committed

Files Reviewed (13 files in diff)

• src/index.ts - path fix only
• src/enhancers/cart/CouponEnhancer.ts - moved from src/enhancers/CouponEnhancer.ts
• src/enhancers/order/OrderItemListEnhancer.ts - doc block additions only
• src/enhancers/order/Upsell/UpsellEnhancer.ts - doc block additions only
• src/enhancers/ui/AccordionEnhancer.ts - doc block additions only
• src/enhancers/ui/ScrollHintEnhancer.ts - doc block additions only
• src/enhancers/ui/TooltipEnhancer.ts - doc block additions only
• src/types/global.ts - extensive doc block additions
• src/types/campaign.ts - doc block additions
• src/utils/events.ts - doc block addition
• src/utils/logger.ts - doc block addition
• typedoc.json - config changes; CRITICAL issue persists
• typedoc.html.json - new config file

---

_{Reviewed by minimax-m2.7 · incremental review}

---

_{Reviewed by minimax-m2.7 · 491,451 tokens}

[kilo-code-bot]

CRITICAL: "skipErrorChecking": false" combined with "treatWarningsAsErrors": true will cause the docs build to fail on any warning. The false default is redundant here while the config remains dangerously strict. Either set skipErrorChecking: true or remove treatWarningsAsErrors until the codebase is fully documented.