Skip to content

docs: surface quick setup script in the Quick Start section#433

Merged
strawgate merged 2 commits intomainfrom
copilot/refactor-quick-start-script
Feb 26, 2026
Merged

docs: surface quick setup script in the Quick Start section#433
strawgate merged 2 commits intomainfrom
copilot/refactor-quick-start-script

Conversation

Copy link
Contributor

Copilot AI commented Feb 26, 2026

The Quick Start section in docs/index.md only documented manual setup, which made the quick-setup.sh path hard to discover.

Changes

  • Promotes the quick setup script as the primary Quick Start path:
curl -fsSL https://raw.githubusercontent.com/elastic/ai-github-actions/v0/scripts/quick-setup.sh \
  | bash -s --
  • Clarifies required tooling for this flow (gh, git, and curl)

  • Documents what the script does by default:

    • installs the starter workflow triggers
    • adds agentics-maintenance.yml
    • sets COPILOT_GITHUB_TOKEN
    • creates a branch, pushes it, and opens a PR
  • Calls out --continuous-improvement for optional continuous-improvement workflow installation

  • Keeps the existing manual setup steps as an alternative

  • Fixes Refer to the quick start script in our quick start docs #432

Generated by Update PR Body for issue #433

Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Copilot AI changed the title [WIP] Update quick start script based on documentation docs: surface quick setup script in the Quick Start section Feb 26, 2026
@strawgate strawgate marked this pull request as ready for review February 26, 2026 23:15
@coderabbitai
Copy link

coderabbitai bot commented Feb 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b056f17 and 7d7ca45.

📒 Files selected for processing (1)
  • docs/index.md

📝 Walkthrough

Walkthrough

A new Quick Start section has been added to docs/index.md that documents a curl-based quick setup script invocation. The section includes default actions, optional flags (--continuous-improvement), and manual setup instructions for Copilot PAT configuration.

Changes

Cohort / File(s) Summary
Quick Start Documentation
docs/index.md
Added Quick Start section describing curl-based setup script invocation, default actions (workflow installation, branch creation, PR opening), and optional --continuous-improvement flag for selected workflows.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A script so quick, with just one bound,
Quick Start docs now spin around!
Curl and flow, then push with glee,
Workflows dance for all to see! 🚀

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: surfacing the quick setup script in the Quick Start documentation section.
Linked Issues check ✅ Passed The PR fully addresses issue #432 by referencing the quick-setup.sh script in Quick Start docs, making the automated setup path discoverable.
Out of Scope Changes check ✅ Passed All changes are directly related to the objective of surfacing the quick setup script in Quick Start documentation; no out-of-scope modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch copilot/refactor-quick-start-script

Comment @coderabbitai help to get the list of available commands and usage tips.

@strawgate strawgate merged commit 4af8840 into main Feb 26, 2026
16 checks passed
@strawgate strawgate deleted the copilot/refactor-quick-start-script branch February 26, 2026 23:20
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.

Refer to the quick start script in our quick start docs

2 participants