Skip to content

Add instructions for LLM-assisted documentation generation - #20565

Open
mjwolf wants to merge 1 commit into
elastic:mainfrom
mjwolf:llm-documentation-guide
Open

Add instructions for LLM-assisted documentation generation#20565
mjwolf wants to merge 1 commit into
elastic:mainfrom
mjwolf:llm-documentation-guide

Conversation

@mjwolf

@mjwolf mjwolf commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Proposed commit message

Elastic-package now contains a LLM-assisted documentation generation command. This updates the integration creation documentation with instructions on how to use elastic-package to help generation documentation with the new command.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Elastic-package now contains a LLM-assisted documentation generation
command. This updates the integration creation documentation with
instructions on how to use elastic-package to help generation
documentation.
@mjwolf mjwolf added the documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. label Aug 5, 2026
@mjwolf
mjwolf requested a review from a team as a code owner August 5, 2026 23:33
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

@teresaromero teresaromero left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just curious; would this be better as a how-to guide on the elastic-package repo? https://github.com/elastic/elastic-package/tree/main/docs/howto

@mergify

mergify Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

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. Applied to PRs that modify *.md files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants