How does it handle truth cases?

The skill reads updated code and relevant truth-case JSONs to highlight key assumptions, invariants, and reference example truth-case IDs in the docs.

What files does Phoenix Docs Sync update?

It specifically targets calculations.md, project READMEs, JSDoc within server analytics files, and phase validation reports.

Can it handle complex financial logic?

Yes, it is specifically designed for complex modules including XIRR, waterfalls, fee structures, and capital allocation logic.

Does it modify code behavior?

No, its primary purpose is to ensure that documentation and JSDoc accurately reflect the existing code behavior and implementation.

Why use this skill instead of manual documentation?

It prevents documentation rot by ensuring every semantic change in calculations is reflected in the documentation within the same change set, maintaining a high standard of technical accuracy.

Phoenix Docs Sync

Name: Phoenix Docs Sync
Author: nikhillinit

bynikhillinit

Learning & Documentation

Synchronizes technical documentation and JSDoc with actual code behavior to ensure accuracy in complex calculation modules.

About

Phoenix Docs Sync is a specialized skill designed to bridge the gap between implementation and documentation within complex financial and analytical codebases. It automatically updates JSDoc, markdown guides, and phase reports whenever changes are made to core modules such as XIRR, waterfalls, or fee structures. By analyzing updated code and truth-case JSON files, the skill ensures that your technical documentation remains a reliable source of truth, effectively preventing 'documentation rot' and ensuring that plain-English descriptions match current mathematical logic.

Key Features

Updates markdown documentation for complex financial calculations like XIRR and waterfalls
Clarifies truth-case semantics and invariant logic in plain English
Synchronizes JSDoc parameters and returns with implementation logic
Ensures consistency between code behavior and phase validation reports
Validates documentation reflects current precision and Decimal.js handling
0 GitHub stars

Use Cases

Updating technical documentation after modifying capital allocation or exit recycling logic
Syncing technical specifications with recent changes in analytics modules
Clarifying clawback behavior in JSDoc after a logic refactor

About

Key Features

Updates markdown documentation for complex financial calculations like XIRR and waterfalls
Clarifies truth-case semantics and invariant logic in plain English
Synchronizes JSDoc parameters and returns with implementation logic
Ensures consistency between code behavior and phase validation reports
Validates documentation reflects current precision and Decimal.js handling
0 GitHub stars

Use Cases

Updating technical documentation after modifying capital allocation or exit recycling logic
Syncing technical specifications with recent changes in analytics modules
Clarifying clawback behavior in JSDoc after a logic refactor