axhub-commentary-client

Axhub Commentary page-side integration workflow

Focus on the page-side integration of Axhub Commentary, with the goal of enabling the page to be recognized, located, read for adjustable properties, and written back by the editor in the Axhub Chrome extension or Make preview environment.

This skill is not responsible for installing the editor runtime. By default, the editor is injected by the Axhub Chrome extension or provided by the Make preview environment. The page side only supplements the necessary context declarations and tweak protocol; if the target project is already usable @axhub/commentary-react, it can be used as a React helper, but do not make installing the NPM package a prerequisite.

Applicable scenarios

When these signals are hit, prioritize using this skill:

• The user wants to "expose editable items" or "make it editable in the adjustment panel"
• The user wants to organize editable items uniformly by page
• The user wants to first produce multiple versions of directions, then compare and decide which version to proceed with
• The user wants to make multiple directions into switchable options within the page
• The user wants to supplement page positioning information to facilitate quickly finding the current page and corresponding implementation during debugging
• The user uses the Axhub Chrome extension or Make preview environment to open the page, but the page lacks recognizable context or adjustment items

Quick triage

• Property editing, page-level property aggregation → read references/property-editing.md
• Multi-option design comparisons, card option switching → read references/design-bid.md
• Page environment information, debugging positioning, host resource context → read references/environment-context.md

Implementation principles

• tweak / schema / values / adapter / update / card option switching prioritize integration with window.__AXHUB_COMMENTARY_TWEAK_PROTOCOL__
• If the React host can already use @axhub/commentary-react, prioritize using its store / adapter / hook to simplify registration; otherwise directly implement the same global tweak protocol
• Page resource context / filePath / targetPath / projectPath prioritize going through page declaration window.__COMMENTARY_HOST__; if the current project originally manually initializes the Commentary runtime, then go through createCommentary(...).host.getResourceContext()
• Terminology alignment schema、values、adapter、update
• Page environment information should prioritize providing the minimum necessary resource context, without piling up temporary debugging noise
• The host is responsible for business fields, default values, and write-back semantics
• Page-level property aggregation is not creating another set of global static configuration, but rather performing aggregated display based on element-level tweak registration results
• If the current environment supports sub-agents, independent implementations can be split off; the main agent retains overall constraints and final review

Delivery requirements

The final reply must contain at least:

• The sub-processes hit
• Which files were modified
• Which properties or option fields were exposed
• Which verifications were performed

Reference

• references/property-editing.md
• references/design-bid.md
• references/environment-context.md
• Axhub Runtime: packages/axhub-commentary/PUBLIC-API.md
• Axhub Runtime: packages/axhub-commentary-react/README.md