Skip to content

docs: align documentation with current implementation - #513

Merged
chensid merged 1 commit into
mainfrom
codex/docs-code-alignment
Aug 3, 2026
Merged

docs: align documentation with current implementation#513
chensid merged 1 commit into
mainfrom
codex/docs-code-alignment

Conversation

@chensid

@chensid chensid commented Aug 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • document the actual lazy-init observer defaults and latching semantics in the English and Chinese READMEs
  • use the public LoadingOption type in the API tables and correct its ECharts 6.1 default-value documentation
  • align the agent API quick reference with the implementation defaults

Why

The implementation had moved ahead of parts of the documentation: lazy-init fallback settings were implicit, loadingOption was described only as object, and loading colors still reflected older ECharts defaults. This keeps the published API docs and generated declaration comments consistent with the current code.

Impact

Documentation and type-comment corrections only; there is no runtime behavior change.

Validation

  • CI=true vp install --frozen-lockfile
  • vp check
  • vp pack (publint + attw)
  • vp test run --coverage — 294 passed, 1 skipped, 100% coverage
  • vp run size

@chensid
chensid merged commit 92758e8 into main Aug 3, 2026
2 checks passed
@chensid
chensid deleted the codex/docs-code-alignment branch August 3, 2026 08:26
@codecov

codecov Bot commented Aug 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (c23d381) to head (8a10911).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #513   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           20        20           
  Lines          648       648           
  Branches       151       151           
=========================================
  Hits           648       648           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant