Skip to content

docs: complete TSDoc accuracy and add guardrails - #3530

Draft
setchy wants to merge 1 commit into
mainfrom
docs/tsdoc-accuracy-02-06
Draft

setchy wants to merge 1 commit into
mainfrom
docs/tsdoc-accuracy-02-06

Conversation

@setchy

@setchy setchy commented Oct 25, 2026

Copy link
Copy Markdown
Member

Summary

Completes the remaining TSDoc accuracy work from improve-tsdoc-accuracy (tasks 2.1-6.6), following the convention added to CONTRIBUTING.md in #3528.

  • Correct argument docs for grouping helpers, notification query keys, the GitHub Actions URL helper, and the notification failure map.
  • Correct behaviour docs for native notifications, the notification pipeline, zoom ranges, keyboard modifiers, GraphQL error handling, formatting, and first-run/second-instance side effects.
  • Use forge-neutral wording in shared notification types and replace the duplicate type block with plain section dividers that preserve the original context.
  • Add the Oxlint jsdoc plugin with low-noise tag rules for TypeScript sources.
  • Add scoped require-param enforcement for src/preload, src/shared, and src/renderer/utils/auth.
  • Add scoped require-returns enforcement for src/shared, where the rule produces meaningful reports without void false positives.
  • Record the coverage baseline in the change design: before enrollment, 102 missing @param and 135 missing @returns reports; after fixing the enrolled scopes, 98 and 133, with every enrolled scope at zero.

Scope

Documentation and lint configuration only. No runtime, IPC contract, or UI behaviour changes.

Verification

  • pnpm check
  • pnpm test (204 test files, 1,974 tests)
  • openspec validate improve-tsdoc-accuracy --type change --strict
  • Deliberately malformed TSDoc tag and an undocumented parameter/return both fail the scoped lint checks, then pass after removal.
  • All 31/31 tasks in improve-tsdoc-accuracy are complete.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 25, 2026
@sonarqubecloud

Copy link
Copy Markdown

This branch has not been deployed

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

Labels

documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

1 participant