chore: changed introduction in the adoption patterns docs

[aaguiarz]

Description

References

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
  • Expanded the introduction to clearly outline three main challenges in adopting the product.
  • Updated references to use "FGA" instead of "OpenFGA" for consistency.
  • Removed a related link about running the product in production, focusing related links on modular authorization models.
  • Made minor wording improvements for clarity.

[github-actions]

PR Preview Action v1.6.2
🚀 View preview at https://openfga.github.io/openfga.dev/pr-preview/pr-1039/
Built to branch gh-pages at 2025-08-07 16:53 UTC. Preview will be ready when the GitHub Pages deployment is complete.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The introductory section of the adoption patterns documentation was expanded to enumerate three main challenges in adopting the product. Wording was adjusted in a section to generalize references to documentation. In the related sections, references to "OpenFGA" were changed to "FGA," and a link about running OpenFGA in production was removed.

Changes

File	Change Summary
docs/content/best-practices/adoption-patterns.mdx	Expanded introduction, generalized documentation reference, changed "OpenFGA" to "FGA," and removed a related link.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation wording and structure.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/adoption-patterns

---

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

Support

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

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 generate unit tests to generate unit tests for 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 (1)

docs/content/best-practices/adoption-patterns.mdx (1)

164-164: Use ProductName component for consistency
Consider replacing the plain text reference with <ProductName format={ProductNameFormat.ShortForm}/> to ensure uniform product naming and future-proof translations.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3f4d874 and 3761883.

📒 Files selected for processing (1)

• docs/content/best-practices/adoption-patterns.mdx (3 hunks)

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

• GitHub Check: deploy-preview
• GitHub Check: Test deployment
• GitHub Check: markdown-link-check
• GitHub Check: Run Checks
• GitHub Check: markdown-link-check-md
• GitHub Check: Analyze (actions)
• GitHub Check: Analyze (javascript)

🔇 Additional comments (2)

docs/content/best-practices/adoption-patterns.mdx (2)

15-21: Expanded introduction clearly outlines adoption challenges
The new bulleted list effectively breaks down the key hurdles readers face, improving clarity and structure.

---

189-197: Verify related links after removal of production guide
The "Running OpenFGA in Production" entry was removed. Please confirm no other docs still reference this guide and, if available, add an updated production deployment link.

#!/bin/bash
# Search for references to the removed production guide title
rg -n "Running OpenFGA in Production" docs/content