Skip to content

Comments

Improve docs-drift and docs-new-contributor-review workflows#211

Merged
strawgate merged 3 commits intoelastic:mainfrom
theletterf:improve-docs-workflows
Feb 20, 2026
Merged

Improve docs-drift and docs-new-contributor-review workflows#211
strawgate merged 3 commits intoelastic:mainfrom
theletterf:improve-docs-workflows

Conversation

@theletterf
Copy link
Contributor

@theletterf theletterf commented Feb 20, 2026

Split external documentation checks out of the base docs workflows into dedicated workflows.

Base workflows (docs-drift, docs-new-contributor-review):

  • Made generic — no repo-specific file paths or workflow references
  • Added dynamic doc discovery (scan for common doc locations instead of hardcoded paths)

New workflows (docs-drift-external, docs-new-contributor-review-external):

  • elastic-docs MCP server for cross-referencing published Elastic documentation
  • applies_to tag validation and backport detection (drift-external)
  • Contradictions with elastic.co/docs flagged as blocking (new-contributor-external)

Also adds: gh-agent-workflows/ entries, mkdocs nav, overview table rows, and smoke test coverage for both new workflows.

docs-drift:
- Add elastic-docs MCP server to detect drift in published Elastic
  documentation, not just local files.
- Add applies_to tag awareness: flag when code changes affect feature
  lifecycle (beta->GA, deprecation, removal) and tags need updating.
- Add backport detection: note when documentation updates need to be
  backported to earlier version branches.
- Make data gathering dynamic instead of assuming a fixed directory
  structure for documentation files.
- Update issue format to include applies_to impact, backport needs,
  and published docs impact sections.

docs-new-contributor-review:
- Replace hardcoded file list with dynamic documentation discovery
  so the workflow is portable to any repository.
- Add elastic-docs MCP server to cross-reference the repo's onboarding
  docs against published Elastic documentation and flag contradictions.

Both workflows also get recompiled lock files to match gh-aw v0.45.1.

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@strawgate strawgate force-pushed the improve-docs-workflows branch from b57942a to ae45736 Compare February 20, 2026 14:40
@strawgate strawgate merged commit b337a6c into elastic:main Feb 20, 2026
8 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants