docs: capitalize Flox brand and use major-version pin - #199
Merged
Conversation
github-actions
Bot
added
the
team-developer-support
garbas
approved these changes
May 13, 2026
brendaneamon
marked this pull request as ready for review
May 13, 2026 16:10
devusb
approved these changes
May 13, 2026
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the README to align with current branding and versioning guidance for the Flox GitHub Action examples.
Changes:
- Capitalizes “Flox” in the README intro and workflow step names (reserving
floxfor CLI usage). - Updates
uses:examples from a specific minor tag (@v2.2.0) to the major tag (@v2) to avoid stale docs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Three small README fixes: - Capitalize the Flox brand in the intro and example step names (the lowercase `flox` is reserved for CLI invocation). Matches the renamed action.yml display name. - Pin code samples to the major-version tag (`@v2`) instead of a specific minor (`@v2.2.0`, now stale). The major-version pattern lets readers track the latest within v2 without rewriting their workflows on every minor release. - Indent the step items under `steps:` in the Getting Started example by two spaces. The compact form is technically valid YAML but the indented form is the more common convention and friendlier to copy-paste into editors with strict linting. Mirrors the equivalent change in `flox/activate-action`. Refs ECO-60.
brendaneamon
force-pushed
the
brendan/eco-60-readme-cleanup
branch
from
May 13, 2026 16:18
76da6ce to
27582df
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three small corrective fixes to
README.md:floxform is reserved for CLI invocation; the brand on product surfaces should beFlox. Matches the renamedaction.ymldisplay name.@v2) instead of a specific minor (@v2.2.0, now stale). The major-version pattern lets readers track the latest within v2 without rewriting their workflows on every minor release.steps:in the Getting Started example by two spaces. The compact form is technically valid YAML, but the indented form is the more common convention and friendlier to copy-paste into editors with strict linting. Mirrors the equivalent change inflox/activate-action.Part of ECO-60 (follow-up README hygiene from the rename work).
Test plan