Skip to content

docs: add naming conventions for entities #2794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ucatbas merged 1 commit into from
Feb 23, 2026
+3 −1
Merged

docs: add naming conventions for entities #2794

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/getting-started/modeling.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,9 @@ The first step to building Permify Schema is creating entities. An entity is an

Think of entities as tables in your database. It is strongly recommended to name entities the same as the corresponding database table name. Doing so allows you to model and reason about your authorization and eliminate the possibility of error.

You can create entities using the `entity` keyword. Let's create some entities for our example GitHub authorization logic.
You can create entities using the `entity` keyword. Entity names may contain only letters and underscores and must be at most 64 characters long.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Trailing whitespace at the end of Line 63.

The sentence ends with ...64 characters long. (note the space after the period). This is a minor formatting nit.

✏️ Proposed fix 
-You can create entities using the `entity` keyword. Entity names may contain only letters and underscores and must be at most 64 characters long. 
+You can create entities using the `entity` keyword. Entity names may contain only letters and underscores and must be at most 64 characters long.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
You can create entities using the `entity` keyword. Entity names may contain only letters and underscores and must be at most 64 characters long.
You can create entities using the `entity` keyword. Entity names may contain only letters and underscores and must be at most 64 characters long.
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/getting-started/modeling.mdx` at line 63, Remove the trailing whitespace
at the end of the sentence "Entity names may contain only letters and
underscores and must be at most 64 characters long." in the docs text (the
sentence shown in the diff) by deleting the extra space after the final period
so the line ends cleanly with the period.


Let's create some entities for our example GitHub authorization logic.

```perm
entity user {}
Expand Down