Skip to content

docs: clarify CLI command surfaces#561

Closed
frostebite wants to merge 4 commits intomainfrom
docs/clarify-cli-command-surfaces
Closed

docs: clarify CLI command surfaces#561
frostebite wants to merge 4 commits intomainfrom
docs/clarify-cli-command-surfaces

Conversation

@frostebite
Copy link
Copy Markdown
Member

@frostebite frostebite commented May 6, 2026

Summary

  • make game-ci orchestrate the documented public CLI command for provider-backed jobs
  • keep game-ci remote run and game-ci remote build documented only as compatibility aliases
  • clarify that standalone Orchestrator also has an orchestrate verb, but with the direct Orchestrator command surface
  • keep the Orchestrator section label as Provider Types and retain serve / orchestrate cache guidance

Verification

  • node_modules/.bin/prettier --write on changed docs
  • yarn build

@frostebite frostebite requested a review from webbertakken May 6, 2026 17:26
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026

Warning

Rate limit exceeded

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

To continue reviewing without waiting, purchase usage credits in the billing tab.

⌛ 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 53a3798d-2762-40e7-b1e4-f5c2f2fc8a95

📥 Commits

Reviewing files that changed from the base of the PR and between 0d2925b and 636a82d.

📒 Files selected for processing (16)
  • docs/03-github-cli/02-build.mdx
  • docs/03-github-cli/03-remote-builds.mdx
  • docs/03-github-cli/04-configuration-and-plugins.mdx
  • docs/03-github-cli/05-github-action.mdx
  • docs/03-github-cli/index.mdx
  • docs/03-github-orchestrator/01-introduction-to-orchestrator/01-introduction.mdx
  • docs/03-github-orchestrator/01-introduction-to-orchestrator/03-getting-started.mdx
  • docs/03-github-orchestrator/01-introduction-to-orchestrator/04-examples/01-command-line.mdx
  • docs/03-github-orchestrator/01-introduction-to-orchestrator/04-examples/02-github-actions.mdx
  • docs/03-github-orchestrator/05-providers/01-overview.mdx
  • docs/03-github-orchestrator/05-providers/_category_.yaml
  • docs/03-github-orchestrator/07-advanced-topics/10-build-services.mdx
  • docs/03-github-orchestrator/08-cli/01-getting-started.mdx
  • docs/03-github-orchestrator/08-cli/02-build-command.mdx
  • docs/03-github-orchestrator/08-cli/03-orchestrate-command.mdx
  • docs/03-github-orchestrator/08-cli/04-other-commands.mdx
📝 Walkthrough

Walkthrough

Documentation refactoring across the GameCI repository updates terminology from "Providers" to "Provider Types," clarifies the relationship between the public game-ci CLI and standalone Orchestrator CLI, and adds guidance sections explaining command surfaces and usage scenarios. No code or public API changes.

Changes

Terminology Alignment: "Providers" → "Provider Types"

Layer / File(s) Summary
Category & Heading Updates
docs/03-github-orchestrator/05-providers/_category_.yaml, docs/03-github-orchestrator/05-providers/01-overview.mdx
Section label and header changed from "Providers" to "Provider Types" with intro text reworded to define the concept and its relationship to providerStrategy.
Reference & Link Updates
docs/03-github-orchestrator/01-introduction-to-orchestrator/01-introduction.mdx, docs/03-github-orchestrator/01-introduction-to-orchestrator/03-getting-started.mdx, docs/03-github-orchestrator/01-introduction-to-orchestrator/04-examples/02-github-actions.mdx, docs/03-github-orchestrator/08-cli/01-getting-started.mdx, docs/03-github-orchestrator/08-cli/03-orchestrate-command.mdx
Links, anchor text, and section references updated from "Providers" to "Provider Types" throughout introduction and CLI documentation.

CLI Documentation: Public vs. Standalone Orchestrator Clarification

Layer / File(s) Summary
Public CLI Overview Updates
docs/03-github-cli/index.mdx, docs/03-github-cli/03-remote-builds.mdx
Added clarification that the standalone Orchestrator CLI is available for advanced tasks, recommended starting point is the public game-ci CLI, and introduced "Command Names At A Glance" section comparing command surfaces and usage contexts.
Standalone Orchestrator CLI Documentation
docs/03-github-orchestrator/08-cli/01-getting-started.mdx, docs/03-github-orchestrator/08-cli/02-build-command.mdx, docs/03-github-orchestrator/08-cli/03-orchestrate-command.mdx, docs/03-github-orchestrator/08-cli/04-other-commands.mdx
Expanded introductions clarifying standalone entry points, added "Command Surface" and "When To Use This Command" sections, restructured provider-strategy tables, updated code examples to use game-ci orchestrate namespace, and documented new serve subcommand for JSON provider protocol.
Engine Support Wording
docs/03-github-cli/04-configuration-and-plugins.mdx
Minor wording adjustment from "engine providers" to "engine support" in Built-In Engine Support section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • game-ci/documentation#541: Overlapping documentation changes renaming "Providers" to "Provider Types" and updating CLI/Orchestrator command guidance and provider-strategy tables.
  • game-ci/documentation#559: Overlapping updates to public game-ci CLI vs standalone Orchestrator CLI framing and related Orchestrator/CLI documentation sections.
  • game-ci/documentation#558: Related Orchestrator documentation structure reorganization, provider-type section rewrites, and CLI/intro reordering.

Suggested reviewers

  • webbertakken

Poem

🐰 Docs hop brightly, terms take flight,
"Providers" now are "Provider Types"—what a delight!
Public and standalone, side by side,
Clear pathways for every user's guide.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description provides a clear summary of changes but does not follow the required template structure with Changes and Checklist sections. Format the description to match the template: add a Changes section with bullet points and include the Checklist section with required items.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: clarifying CLI command surfaces across public and standalone Orchestrator CLIs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/clarify-cli-command-surfaces

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

Visit the preview URL for this PR (updated for commit 636a82d):

https://game-ci-5559f--pr561-docs-clarify-cli-com-z9qjenh9.web.app

(expires Wed, 13 May 2026 18:58:58 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 1f0574f15f83e11bfc148eae8646486a6d0e078b

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

Cat Gif

@frostebite frostebite force-pushed the docs/clarify-cli-command-surfaces branch from cdf15b6 to c3629fd Compare May 6, 2026 18:10
@frostebite frostebite enabled auto-merge (squash) May 6, 2026 18:57
@frostebite
Copy link
Copy Markdown
Member Author

Combined into a single PR.

@frostebite frostebite closed this May 6, 2026
auto-merge was automatically disabled May 6, 2026 21:41

Pull request was closed

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.

1 participant