chore(docs): update README

[rhamzeh]

Description

What problem is being solved?

How is it being solved?

What changes are made to solve it?

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
  • Restructured and expanded README with comprehensive OpenFGA API introduction
  • Added About, Usage, and Contributing guidance sections
  • Included step-by-step setup instructions for building and using generated sources
  • Added workflow documentation for OpenAPI generation
  • Enhanced with SDK references, CLI commands, and contributor resources

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

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

README.md was expanded with detailed sections covering OpenFGA API introduction, usage instructions, generating sources and documentation workflows, and contributor guidance. The documentation transitioned from a brief description to comprehensive onboarding material including build commands, Go module setup, and contributing resources.

Changes

Cohort / File(s)	Summary
Documentation Update README.md	Expanded with About section, Usage notes, Building Generated Sources workflow (buf-gen), explicit Go module initialization instructions, Generating OpenAPI Documentation workflow, and Contributing guidance with relevant resource links and author/license information

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• No code logic changes, only documentation restructuring and expansion
• Review is straightforward since changes are purely informational and organizational

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'chore(docs): update README' is vague and generic, using the non-descriptive term 'update' without specifying what aspects of the README were actually modified.	Provide a more specific title that describes the key changes, such as 'chore(docs): expand README with usage guide and contribution guidelines' or similar.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

---

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

[Copilot]

Pull Request Overview

This PR enhances the README.md by adding comprehensive documentation sections including an About section describing OpenFGA, expanded usage instructions with SDK examples, and proper documentation structure with Author and License sections.

Key Changes

• Added "About" section explaining OpenFGA's purpose and origins
• Expanded "Usage" section with SDK import examples
• Restructured existing sections under a new "Contributing" parent section

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

README.md (3)

6-6: Fix grammar: hyphenate "open-source".

Line 6 should use the hyphenated form open-source when used as a compound adjective before a noun.

-OpenFGA](https://openfga.dev) is an open source Fine-Grained Authorization solution inspired by [Google's Zanzibar paper](https://research.google/pubs/pub48190/). It was created by the FGA team at [Auth0/Okta](https://auth0.com) based on [Auth0 Fine-Grained Authorization (FGA)](https://fga.dev), available under [a permissive license (Apache-2)](https://github.com/openfga/rfcs/blob/main/LICENSE) and welcomes community contributions.
+OpenFGA](https://openfga.dev) is an open-source Fine-Grained Authorization solution inspired by [Google's Zanzibar paper](https://research.google/pubs/pub48190/). It was created by the FGA team at [Auth0/Okta](https://auth0.com) based on [Auth0 Fine-Grained Authorization (FGA)](https://fga.dev), available under [a permissive license (Apache-2)](https://github.com/openfga/rfcs/blob/main/LICENSE) and welcomes community contributions.

---

15-15: Format bare URL as markdown link (MD034).

Line 15 contains a bare URL that should be wrapped in markdown link syntax for consistency with documentation standards.

-You can find various SDKs autogenerated by buf based on the protobuf definitions here: https://buf.build/openfga/api/sdks/main:protobuf 
+You can find various SDKs autogenerated by buf based on the protobuf definitions [here](https://buf.build/openfga/api/sdks/main:protobuf).

---

23-23: Format bare URL as markdown link (MD034).

Line 23 contains a bare URL that should be wrapped in markdown link syntax for consistency with documentation standards.

-If you are looking for the currently supported OpenFGA HTTP SDKs, you can find them here: https://github.com/openfga/sdk-generator#currently-supported-sdks
+If you are looking for the currently supported OpenFGA HTTP SDKs, you can find them [here](https://github.com/openfga/sdk-generator#currently-supported-sdks).

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0ac19aa and 0ce38cd.

📒 Files selected for processing (1)

• README.md (4 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[grammar] ~6-~6: Use a hyphen to join words.
Context: ...OpenFGA](https://openfga.dev) is an open source Fine-Grained Authorization soluti...

(QB_NEW_EN_HYPHEN)

🪛 markdownlint-cli2 (0.18.1)

README.md

15-15: Bare URL used

(MD034, no-bare-urls)

---

23-23: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (2)

README.md (2)

77-77: Verify LICENSE file reference.

Line 77 references the LICENSE file from openfga/cli repository. Please confirm this is intentional or if it should reference the LICENSE file from the openfga/api repository instead.

---

1-77: Excellent expansion of documentation coverage.

The README has been significantly enhanced with comprehensive sections covering the project's purpose, usage instructions, contribution workflows, and references. The additions provide clear onboarding guidance for both users and contributors, including:

• Clear project context (About section)
• SDK discovery and Go module setup instructions (Usage section)
• Step-by-step workflows for building and using generated sources (Contributing subsections)
• OpenAPI documentation generation process

These improvements substantially raise the documentation quality and accessibility for new users and contributors.