Add modify mode to elastic-package update documentation

[mjwolf]

Extends the AI-powered documentation command with a targeted modification mode, complementing the existing full-rewrite mode.

With modify mode, the user will be prompted for a description of the change to apply to the existing documentation.

The LLM will apply the described change by first analyzing what section(s) the change applies to. It will then apply the change to all relevent sections. In interactive mode, the user will be shown a preview of the prompt, and be given an option to accept it, or repeat the process to make futher changes to the documentation.

How modify mode works:

• Scope analysis (modificationanalyzer.go): Before making changes, the LLM analyzes the modification request and classifies it as global (affects the whole document), specific (affects named sections), or ambiguous. Specific-scope modifications only regenerate the relevant sections, leaving the rest untouched.
• Section-aware application: Modifications are applied section-by-section. For specific scope, only affected sections (including their subsections) are regenerated; for global/ambiguous scope, all sections are rewritten with the modification context.
• Interactive revision loop: In interactive mode, after reviewing the output users can now choose "Request changes" in addition to Accept/Cancel. This prompts for new instructions and re-runs the modification workflow, allowing iterative refinement without starting over.

[github-actions]

TL;DR

make check-static is failing on lint issues introduced in internal/llmagent/docagent/modificationanalyzer.go: two staticcheck QF1012 findings and one unparam finding. This is a code cleanup fix, not an infrastructure or flaky-test failure.

Remediation

• In internal/llmagent/docagent/modificationanalyzer.go, replace both sectionsBuilder.WriteString(fmt.Sprintf(...)) calls with fmt.Fprintf(&sectionsBuilder, ...).
• Make analyzeModificationScope return only *ModificationScope because every path currently returns a nil error, then update the two call sites in internal/llmagent/docagent/docagent.go to stop checking an impossible error.
• Re-run make check-static after the cleanup.

Investigation details

Root Cause

The failed job is :go: Run check-static, running make check-static, and golangci-lint reports three deterministic lint failures in PR-added code:

• internal/llmagent/docagent/modificationanalyzer.go:89 and :94 use sectionsBuilder.WriteString(fmt.Sprintf(...)), which staticcheck flags as QF1012.
• internal/llmagent/docagent/modificationanalyzer.go:59 declares func (d *DocumentationAgent) analyzeModificationScope(...) (*ModificationScope, error), but the implementation always returns nil for the error. That triggers unparam.

The error result is not needed for the current behavior: modificationanalyzer.go:67-78 logs failures and returns defaultModificationScope(...) with nil, while both call sites already fall back to the same global-scope behavior if an error were possible:

• internal/llmagent/docagent/docagent.go:366-370
• internal/llmagent/docagent/docagent.go:625-629

So the behavior-preserving fix is to remove the error return from analyzeModificationScope and simplify those call sites.

Evidence

• Build: https://buildkite.com/elastic/elastic-package/builds/8231
• Job/step: :go: Run check-static
• Key log excerpt:

internal/llmagent/docagent/modificationanalyzer.go:89:3: QF1012: Use fmt.Fprintf(...) instead of WriteString(fmt.Sprintf(...)) (staticcheck)
internal/llmagent/docagent/modificationanalyzer.go:94:4: QF1012: Use fmt.Fprintf(...) instead of WriteString(fmt.Sprintf(...)) (staticcheck)
internal/llmagent/docagent/modificationanalyzer.go:59:153: (*DocumentationAgent).analyzeModificationScope - result 1 (error) is always nil (unparam)
3 issues:
* staticcheck: 2
* unparam: 1
make: *** [Makefile:42: lint] Error 1

Verification

Not run locally; this detective pass inspected the failing Buildkite log and PR-head source. The recommended validation is make check-static.

---

What is this? | From workflow: PR Buildkite Detective

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

[jsoriano]

Changes in cmd LGTM.

[vinit-chauhan]

LGTM

[infra-vault-gh-plugin-prod]

💚 Build Succeeded

• Buildkite Build
• Commit: d2acf14

History

• 💔 Build #8231 failed 06c8fe5

[mrodm]

Changes related to cmd LGTM 👍