feat: enhance cli config file location documentation

[OsmanMElsayed]

Description

Add more clarity around the cli config file location documentation and update it with the latest change in in openfga/cli#504

References

• Make it possible to read the configuration file from the current directory cli#473
• feat: load the config file from the current working directory cli#504

Review Checklist

• I have clicked on "allow edits by maintainers".
• I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
• The correct base branch is being used, if not main
• I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

• Documentation
  • Clarified and expanded the description of how the CLI locates the .fga.yaml configuration file, detailing the prioritized search order and platform-specific paths.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: OsmanMElsayed / name: Osman M Elsayed (0fd4e25, e91a89c, 914e1c7)

[coderabbitai]

Walkthrough

The documentation for the FGA CLI configuration file was updated to specify the prioritized search order and possible locations for the .fga.yaml file, including platform-specific directories and subdirectories, providing a more explicit hierarchy for configuration file discovery.

Changes

File(s)	Change Summary
docs/content/getting-started/cli.mdx	Expanded documentation to clarify the prioritized search order and locations for .fga.yaml config.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation updates.

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/content/getting-started/cli.mdx (2)

22-23: Avoid repetitive sentence starts for smoother reading

The three bullets in lines 20–23 all start with “Using …”. Re-phrasing one or two of them (e.g., “Via CLI flags”, “Environment variables”, “A .fga.yaml config file …”) removes the monotony and reads more naturally.

---

27-28: Correct Windows environment-variable casing

Windows environment variables are conventionally written in all-caps. Replace %AppData% with %APPDATA% for accuracy and consistency with other docs.

-     * Windows: %AppData%
+     * Windows: %APPDATA%

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d64dd1c and 0fd4e25.

📒 Files selected for processing (1)

• docs/content/getting-started/cli.mdx (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/content/getting-started/cli.mdx

[style] ~22-~22: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...flags. - Using environment variables. - Using a .fga.yaml configuration file, searc...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: deploy-preview
• GitHub Check: markdown-link-check-md
• GitHub Check: markdown-link-check
• GitHub Check: Run Checks
• GitHub Check: Test deployment