Public API Docs Coverage

复制 Prompt

/goal
GOAL:
Complete Public API Docs Coverage for a developer-facing documentation site or repository: Add JSDoc and examples for public functions while keeping documentation links valid.

CONTEXT:
- Before editing, read the nearest AGENTS.md/CLAUDE.md, current issue or PLAN.md, and any failing logs already in the repo.
- Inspect README, docs, examples, runbooks, and lint configuration.
- Establish a baseline by running or locating evidence for: `docs coverage and broken link check`.

CONSTRAINTS:
- Keep the scope limited to this goal; do not expand into unrelated cleanup.
- Do not weaken tests, delete assertions, or mask errors to make verification pass.
- Respect the repository's AGENTS.md/CLAUDE.md instructions and existing patterns.
- Do not invent APIs, flags, commands, or product behavior.
- Mark unverified commands clearly instead of presenting guesses as facts.

DONE WHEN:
- The implementation or documentation directly satisfies: Add JSDoc and examples for public functions while keeping documentation links valid.
- The verification command or evidence path succeeds: `docs coverage and broken link check`.
- The final diff is scoped to the relevant files and has no unrelated formatting churn.

VERIFY:
- Run `docs coverage and broken link check` or the closest repo-local equivalent if the exact command is not available.
- Capture before/after evidence for the behavior, metric, report, or artifact involved.
- If verification cannot run locally, stop and report the missing dependency instead of guessing success.

OUTPUT:
- Summarize changed files, key decisions, verification output, and remaining risks.
- Include any follow-up that is required for production rollout or human review.

STOP RULES:
- Pause if secrets, production access, stakeholder decisions, or destructive data operations are required.
- Pause after three failed fix attempts on the same symptom and challenge the root-cause hypothesis.
- Do not mark the goal complete until the current repository state has been audited against DONE WHEN.