openfga.dev icon indicating copy to clipboard operation
openfga.dev copied to clipboard

Update getting-started.mdx

Open austin047 opened this issue 9 months ago • 1 comments

Description

Added drive to the parent relationship with a document

Review Checklist

  • [x] I have clicked on "allow edits by maintainers".
  • [x] 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]
  • [x] The correct base branch is being used, if not main
  • [x] I have added tests to validate that the change in functionality is working as expected

austin047 avatar Feb 23 '25 22:02 austin047

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: austin047 / name: Fuh Austin (26261565cf7d5d6c37d0278b70340da71584e698)
  • :white_check_mark: login: rhamzeh / name: Raghd Hamzeh (82402fd570f007075b883833077d8594f6dcf906)

Walkthrough

Updated two example type definitions in docs/content/modeling/getting-started.mdx to allow both folder and drive as valid parent types in the parent relation. No other relations, logic, or files were changed.

Changes

Cohort / File(s) Summary of Changes
Docs: Modeling examples
docs/content/modeling/getting-started.mdx
In Organization and Document Complete Type Definitions, metadata.relations.parent.directly_related_user_types expanded from [{ type: 'folder' }] to [{ type: 'folder' }, { type: 'drive' }]. No other edits.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches
🧪 Generate unit tests
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

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
🪧 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.
    • 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.
  • 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 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/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit 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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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[bot] avatar Sep 04 '25 18:09 coderabbitai[bot]

Thanks @austin047 - sorry for the delay in reviewing this

rhamzeh avatar Sep 04 '25 18:09 rhamzeh