fix(docs): use-flakehub inconsistency

[Malix-Labs]

Description

Fix documentation inconsistency for use-flakehub

CLOSES: #183

Summary by CodeRabbit

• Documentation
  • Updated configuration documentation to reflect changes in default parameter settings.

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation update to remove the default value for the use-flakehub parameter in the README, aligning it with the null default specified in action.yml and resolving an inconsistency between the two files.

Changes

Cohort / File(s)	Summary
Documentation Fix README.md	Removed default = true from the use-flakehub parameter documentation to align with the default = null value specified in action.yml.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

📖 A little hop through docs so fine,
Where defaults dance and must align—
The flakehub truth now shines so clear,
No more confusion, cheers! 🐰✨

🚥 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 clearly describes the main change: fixing documentation inconsistency for the use-flakehub parameter.
Linked Issues check	✅ Passed	The PR addresses the core requirement from issue #183: resolving the inconsistency between action.yml (default: null) and README.md (default: true) for the use-flakehub parameter.
Out of Scope Changes check	✅ Passed	All changes are scoped to documenting the correct default for use-flakehub; no unrelated 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

📝 Coding Plan

• Generate coding plan for human review comments

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

🧹 Nitpick comments (1)

README.md (1)

117-117: Consider improving documentation clarity for the default behavior.

While the change correctly resolves the inconsistency with action.yml, the empty default column may leave users uncertain about the actual behavior. According to action.yml (context snippet 1), default: null means "have FlakeHub Cache turn on opportunistically (default)."

Additionally, the description could be enhanced to match action.yml's detail level, which explains the trinary options:

• Set to "no-preference" or null for opportunistic mode (default)
• Set to "enabled" or true to explicitly request FlakeHub Cache
• Set to "disabled" or false to explicitly disable FlakeHub Cache

📝 Suggested documentation improvements

Option 1: Add explanatory default value

-| `use-flakehub`              | Whether to upload build results to FlakeHub Cache (private beta).                                               |          |                                                          |
+| `use-flakehub`              | Whether to upload build results to FlakeHub Cache (private beta).                                               |          | `null` (opportunistic mode)                              |

Option 2: Enhance the description to explain trinary behavior

-| `use-flakehub`              | Whether to upload build results to FlakeHub Cache (private beta).                                               |          |                                                          |
+| `use-flakehub`              | Whether to upload build results to FlakeHub Cache. Set to "enabled"/true to explicitly enable, "disabled"/false to disable, or "no-preference"/null for opportunistic mode (default). |          | `null`                                                   |

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 117, Update the README entry for the use-flakehub option
to reflect the actual default and trinary behavior shown in action.yml: change
the empty default column to "null (opportunistic/default)" and expand the
description to explain the three valid settings—null or "no-preference" for
opportunistic default, "enabled" or true to explicitly request FlakeHub Cache,
and "disabled" or false to explicitly disable it—so users see the same semantics
as action.yml's default: null.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Line 117: Update the README entry for the use-flakehub option to reflect the
actual default and trinary behavior shown in action.yml: change the empty
default column to "null (opportunistic/default)" and expand the description to
explain the three valid settings—null or "no-preference" for opportunistic
default, "enabled" or true to explicitly request FlakeHub Cache, and "disabled"
or false to explicitly disable it—so users see the same semantics as
action.yml's default: null.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8ce3d1bb-4669-47f6-9606-f079580a1d74

📥 Commits

Reviewing files that changed from the base of the PR and between cec65ff and 478f392.

📒 Files selected for processing (1)

• README.md