Docs New Contributor Review External¶

Review docs from a new contributor perspective, cross-referencing against published Elastic documentation.

How it works¶

Same as Docs New Contributor Review, but also cross-references the repo's documentation against published Elastic docs on elastic.co/docs, flagging contradictions that would block an external contributor.

Quick Install¶

mkdir -p .github/workflows && curl -sL \
  https://raw.githubusercontent.com/elastic/ai-github-actions/v0/gh-agent-workflows/docs-new-contributor-review-external/example.yml \
  -o .github/workflows/docs-new-contributor-review-external.yml

Trigger¶

Event	Schedule
`schedule`	Weekly
`workflow_dispatch`	Manual

Inputs¶

Input	Description	Required	Default
`additional-instructions`	Repo-specific instructions appended to the agent prompt	No	`""`
`setup-commands`	Shell commands run before the agent starts	No	`""`
`allowed-bot-users`	Allowlisted bot actor usernames (comma-separated)	No	`github-actions[bot]`

Safe Outputs¶

create-issue — file a docs improvement report with external docs findings (max 1, auto-closes older reports)

Example Workflow¶

name: Docs New Contributor Review External
on:
  schedule:
    - cron: "0 14 * * 1"
  workflow_dispatch:

permissions:
  contents: read
  issues: write
  pull-requests: read

jobs:
  run:
    uses: elastic/ai-github-actions/.github/workflows/gh-aw-docs-new-contributor-review-external.lock.yml@v0
    secrets:
      COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}