fix-package-docs
Fix Package Docs
Systematically find and fix all actionable API documentation issues in a Kibana plugin or package using check_package_docs.
Non-negotiable conventions
- Only add JSDoc to exported public API — skip internal helpers that happen to be exported.
- Never change runtime behavior — documentation edits only (no logic, type, or signature changes).
- Use
/** ... */style (not//). Single-line/** Description. */for simple items; multi-line for complex ones. - Descriptions are sentences: start with a capital letter, end with a period.
@param name - Description.(hyphen separator, not colon). Match every parameter in the signature.- Destructured object parameters: document nested properties with dot-notation tags (e.g.,
@param options.foo - Description.). The tooling supports arbitrary nesting (e.g.,@param fns.fn1.foo.param). Each level must have its own@paramtag. @returnsfor non-void functions: always present; omit only forvoid/Promise<void>.- Use
{@link OtherType}for cross-references to other Kibana types. missingExportsitems need human judgment to decide whether to export — skip them and note in PR.
Workflow
1. Resolve the target
More from elastic/kibana
codeql
Work with CodeQL in Kibana — write, test, and debug custom queries locally, fetch scan results from GitHub, and validate inline suppression comments. Use when writing or debugging CodeQL queries, running CodeQL unit tests, analyzing SARIF results, fetching scan results, or checking codeql suppression justifications.
1optimize-bundle-size
Reduce plugin `page load bundle size` and avoid unnecessary increases in `packages/kbn-optimizer/limits.yml`. Use when proactively optimizing bundles, investigating CI page-load overages, or reviewing PRs that change bundle limits.
1kibana-api
Shared utilities for interacting with a local Kibana instance. Provides auto-detection of Kibana URL and auth, and a kibana_curl wrapper.
1api-authz
Kibana API route authorization patterns. Use when configuring route security, working with requiredPrivileges, using authzResult for privilege-based branching, opting out of authorization, or naming custom privileges.
1ftr-testing
Deep reference for the Kibana Functional Test Runner (FTR). Use when reading, analyzing, debugging, or reviewing FTR tests, including config anatomy, services, page objects, loadTestFile patterns, data loading, tags, CI wiring, and common FTR idioms.
1validate-oas
Use when you need a quick VALID or NOT VALID result for a scoped Kibana OAS area, and first ensure the generated `oas_docs` inputs are up to date so validation runs against the current environment rather than stale snapshots.
1