Clarify workflow filename and config source in docs

[efremidze]

Motivation

• Make the repository guidance explicit that the CLI and Action read .github/agent.yml as the single source of truth and that legacy/root groundkeeper.yml files are not used.
• Align example workflow filenames and call out that the workflow filename is flexible while indicating this repo's convention (.github/workflows/groundkeeper.yml).

Description

• Updated README.md to state that Groundkeeper reads .github/agent.yml as the source of truth and that other example configs (such as a root groundkeeper.yml) are not used by the CLI or Action.
• Updated README.md and QUICKSTART.md examples to use .github/workflows/groundkeeper.yml and clarified that the workflow filename is flexible while noting the repo convention.
• Minor wording adjustments to align the quickstart and README guidance about configuration and CI usage.

Testing

• No automated tests were run because this is a documentation-only change.

---

Codex Task

Summary by CodeRabbit

• Documentation
  • Updated GitHub Action usage guidance to clarify workflow filename flexibility and configuration options.
  • Clarified that the default configuration source is read from a specific location, while an alternative configuration file is only used when explicitly specified.
  • Updated CI/CD examples to reflect current workflow naming conventions.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

@efremidze has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 18 minutes and 41 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

Updated documentation to treat .github/agent.yml as the default authoritative config and replaced example workflow references from .github/workflows/maintenance.yml to .github/workflows/groundkeeper.yml in QUICKSTART.md and README.md.

Changes

Cohort / File(s)	Summary
Documentation Clarifications QUICKSTART.md, README.md	Clarified that .github/agent.yml is the default source of truth and that root groundkeeper.yml is used only if explicitly passed via --config; updated GitHub Actions workflow examples to reference .github/workflows/groundkeeper.yml instead of .github/workflows/maintenance.yml and noted filename flexibility.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I nibble docs and straighten the way, 🐇
Agent.yml leads — no more gray,
Maintenance renamed to groundkeeper's play,
Examples aligned, neat as a tray,
A rabbit hums: organized day! 🎉

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

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

[Copilot]

Pull request overview

This PR clarifies documentation about configuration file locations and workflow naming conventions in Groundkeeper.

Changes:

• Clarified that .github/agent.yml is the single source of truth for configuration, explicitly noting that legacy groundkeeper.yml files are not used by the CLI or Action
• Updated workflow filename examples from maintenance.yml to groundkeeper.yml to align with the repository's actual convention, while noting that workflow filenames are flexible

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
README.md	Updated workflow filename references and added explicit clarification about config file source of truth
QUICKSTART.md	Updated workflow filename reference and clarified config file location and usage

Comments suppressed due to low confidence (1)

QUICKSTART.md:41

• The phrase "in your repository root" is misleading. The file .github/agent.yml is located in the .github/ subdirectory, not in the repository root. Consider changing to "Create .github/agent.yml in your repository" or "Create .github/agent.yml (in the .github/ directory)".

Create `.github/agent.yml` in your repository root and validate it against `packages/schemas/agent.schema.json`:

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.