docs: update content in intro and add sign up #1573
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe changes involve updates to the user interface and documentation for the Permify authorization system. Key modifications include renaming and rebranding elements in the navigation and top bar, such as changing the "Playground" button to "Sign Up" and updating URLs. Documentation has been revised for clarity, emphasizing centralized authorization services and the capabilities of the Permify system. Sections have been restructured, descriptions refined, and terminology adjusted to enhance readability and user engagement. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant UI
participant PermifyService
User->>UI: Click "Sign Up"
UI->>PermifyService: Redirect to sign-up page
User->>PermifyService: Complete sign-up
PermifyService-->>User: Confirmation
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (3)
Additional context usedLanguageTool
Additional comments not posted (15)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 4
Outside diff range and nitpick comments (4)
docs/permify-overview/authorization-service.mdx (4)
9-12: LGTM, with minor suggestions!The changes improve clarity and coherence by highlighting the difficulties of managing ad-hoc authorization systems and the inefficiencies of traditional RBAC.
Consider the following suggestions from the static analysis tool to further improve the text:
- Line 9: Consider using a synonym for "hard" to elevate your writing.
- Line 10: Add a comma after "Also" since it is a conjunctive/linking adverb at the start of the sentence.
- Line 11: Change "is" to "are" to ensure subject-verb agreement with "Traditional approaches".
Tools
LanguageTool
[style] ~9-~9: To elevate your writing, try using a synonym here.
Context: ...ered throughout your app's codebase are hard to manage, reason about, and iterate on...(HARD_TO)
[uncategorized] ~10-~10: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ... and iterate on as the company grows. Also you will need to have more specific acc...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~11-~11: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ... grow. Traditional approaches like RBAC is inefficient for defining granular permi...(AI_HYDRA_LEO_CPT_IS_ARE)
13-13: Add a possessive apostrophe.Consider adding a possessive apostrophe to "applications" as suggested by the static analysis tool:
-No matter how you've set up your architecture, you're going to need a solid plan to handle permissions between services, all while keeping it separate from your applications main code. +No matter how you've set up your architecture, you're going to need a solid plan to handle permissions between services, all while keeping it separate from your application's main code.Tools
LanguageTool
[uncategorized] ~13-~13: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...all while keeping it separate from your applications main code. In a monolithic app, you ca...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
17-29: Fix grammar and typos.Consider the following suggestions from the static analysis tool to improve the text:
- Line 19: Change "cater" to "caters" to ensure subject-verb agreement with "centralized engine".
- Line 19: Use "it's" (it is) instead of "its" (belonging to it).
- Line 29: Use "a" instead of "an" before "Centralized Authorization" since "Centralized" doesn't start with a vowel sound.
Tools
LanguageTool
[grammar] ~19-~19: Possible subject-verb agreement error detected.
Context: ...entralized engine, that cater apps that has many services. But its not an easy proc...(PLURAL_THAT_AGREEMENT)
[uncategorized] ~19-~19: “its” (belonging to it) seems less likely than “it’s” (it is)
Context: ... cater apps that has many services. But its not an easy process for [several reason...(AI_HYDRA_LEO_CPT_ITS_ITIS)
[style] ~25-~25: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ...zed authorization service** that offers a variety of binding and crafting options to secure ...(A_VARIETY_OF)
[misspelling] ~29-~29: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...f07-831c-3e0d0e39eccf.png) ## Building an Centralized Authorization is Hard Buil...(EN_A_VS_AN)
41-43: Fix the repeated word.Remove the repeated word "to" as suggested by the static analysis tool:
-Another point is, you probably need to have an additional service to to store your authorization data model, which generally includes saving and updating essential permissions like roles, attributes or relationships. +Another point is, you probably need to have an additional service to store your authorization data model, which generally includes saving and updating essential permissions like roles, attributes or relationships.Tools
LanguageTool
[style] ~41-~41: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... times. Another point is, you probably need to have an additional service to to store ...(REP_NEED_TO_VB)
[duplication] ~41-~41: Possible typo: you repeated a word
Context: ...ably need to have an additional service to to store your authorization data model, wh...(ENGLISH_WORD_REPEAT_RULE)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- docs/mint.json (3 hunks)
- docs/permify-overview/authorization-service.mdx (2 hunks)
- docs/permify-overview/intro.mdx (3 hunks)
Additional context used
LanguageTool
docs/permify-overview/intro.mdx
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...thorization systems. Permify centrally position itself in your environment as a service...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[style] ~42-~42: In American English, abbreviations like “etc.” require a period.
Context: ...-specific, hierarchical, context aware, etc) permissions and policies using Permify...(ETC_PERIOD)
[uncategorized] ~42-~42: When ‘domain-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...ermissions and policies using Permify's domain specific language that is compatible with RBAC, ...(SPECIFIC_HYPHEN)
[uncategorized] ~44-~44: The preposition ‘in’ seems more likely in this position.
Context: ...ta** - Store authorization-related data as structured relationships to efficiently...(AI_HYDRA_LEO_REPLACE_AS_IN)
[uncategorized] ~79-~79: A comma might be missing here.
Context: ...ce. For feature requests, bugs, or any improvements you can always open an [issue](https://...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~83-~83: Consider using a different verb for a more formal wording.
Context: ...t can be! You can develop new features, fix existing issues or make third-party int...(FIX_RESOLVE)
[grammar] ~87-~87: The usual preposition for “contribution” is “to”. Did you mean “contributions to”?
Context: ...tures. You can find more details about contributions on [CONTRIBUTING.md](https://github.com/Pe...(ON_THE_NOVEL)
docs/permify-overview/authorization-service.mdx
[style] ~9-~9: To elevate your writing, try using a synonym here.
Context: ...ered throughout your app's codebase are hard to manage, reason about, and iterate on...(HARD_TO)
[uncategorized] ~10-~10: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ... and iterate on as the company grows. Also you will need to have more specific acc...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~11-~11: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ... grow. Traditional approaches like RBAC is inefficient for defining granular permi...(AI_HYDRA_LEO_CPT_IS_ARE)
[uncategorized] ~13-~13: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...all while keeping it separate from your applications main code. In a monolithic app, you ca...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[grammar] ~19-~19: Possible subject-verb agreement error detected.
Context: ...entralized engine, that cater apps that has many services. But its not an easy proc...(PLURAL_THAT_AGREEMENT)
[uncategorized] ~19-~19: “its” (belonging to it) seems less likely than “it’s” (it is)
Context: ... cater apps that has many services. But its not an easy process for [several reason...(AI_HYDRA_LEO_CPT_ITS_ITIS)
[style] ~25-~25: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ...zed authorization service** that offers a variety of binding and crafting options to secure ...(A_VARIETY_OF)
[misspelling] ~29-~29: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...f07-831c-3e0d0e39eccf.png) ## Building an Centralized Authorization is Hard Buil...(EN_A_VS_AN)
[style] ~41-~41: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... times. Another point is, you probably need to have an additional service to to store ...(REP_NEED_TO_VB)
[duplication] ~41-~41: Possible typo: you repeated a word
Context: ...ably need to have an additional service to to store your authorization data model, wh...(ENGLISH_WORD_REPEAT_RULE)
Additional comments not posted (15)
docs/permify-overview/intro.mdx (11)
3-3: LGTM!The change to the
descriptionfront matter enhances the specificity by highlighting the capability to build "fine-grained" authorization systems. This aligns with the goal of providing more detail and clarity about the product's capabilities.
27-27: LGTM!The change in the motivation section emphasizes the goal of eliminating the authorization burden for developers. This highlights a developer-centric approach and aligns with the overall goal of improving clarity and specificity in the documentation.
29-30: LGTM!The change from singular to plural form "authorization systems" is a minor grammatical adjustment that maintains consistency with the usage in other parts of the document.
40-41: LGTM!The reformatting of the bullet point with a bold heading and the expanded description enhance the clarity and readability of the key features. This aligns with the goal of improving the presentation of the product's capabilities for better user engagement.
44-44: LGTM!The changes to the description of storing authorization data are clear and concise.
Tools
LanguageTool
[uncategorized] ~44-~44: The preposition ‘in’ seems more likely in this position.
Context: ...ta** - Store authorization-related data as structured relationships to efficiently...(AI_HYDRA_LEO_REPLACE_AS_IN)
46-48: LGTM!The modifications to the API interaction description and the addition of the custom authorization for tenants enhance the presentation of the product's capabilities. These changes align with the goal of providing a more detailed and comprehensive overview of the features.
56-63: LGTM!The change from "relations" to "relationships" improves the precision of the terminology used in the document. The simplification of the call to action for Permify Playground maintains the invitation to explore the tool while removing unnecessary wording. These changes align with the overall goal of enhancing clarity and user engagement.
Line range hint
68-77:Tools
LanguageTool
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...thorization systems. Permify centrally position itself in your environment as a service...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[style] ~42-~42: In American English, abbreviations like “etc.” require a period.
Context: ...-specific, hierarchical, context aware, etc) permissions and policies using Permify...(ETC_PERIOD)
[uncategorized] ~42-~42: When ‘domain-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...ermissions and policies using Permify's domain specific language that is compatible with RBAC, ...(SPECIFIC_HYPHEN)
[uncategorized] ~44-~44: The preposition ‘in’ seems more likely in this position.
Context: ...ta** - Store authorization-related data as structured relationships to efficiently...(AI_HYDRA_LEO_REPLACE_AS_IN)
81-81: LGTM!The addition of the "Want to Contribute?" section provides valuable information for users interested in contributing to the Permify project. The list of contribution options is clear and concise, encouraging community engagement and collaboration.
83-83: LGTM!The description of contributing to the codebase is clear and concise. The use of the term "fix" is acceptable and easily understood by the target audience of developers.
Tools
LanguageTool
[style] ~83-~83: Consider using a different verb for a more formal wording.
Context: ...t can be! You can develop new features, fix existing issues or make third-party int...(FIX_RESOLVE)
91-92: LGTM!The addition of the link to Permify's public roadmap provides valuable information for users interested in the project's future development and plans. The link is clearly presented and easily accessible.
docs/permify-overview/authorization-service.mdx (1)
7-8: LGTM!The changes improve clarity and coherence by emphasizing the challenges of scaling authorization systems as applications grow.
docs/mint.json (3)
33-34: LGTM!The changes to the
topbarCtaButtonentry are approved. Renaming the button to "Sign Up" and updating the URL to point to a dedicated sign-up page aligns with the PR objective of implementing a sign-up feature and improving user engagement.
228-230: LGTM!The changes to the
navigationentry for "Playground" are approved. Renaming the entry, updating the icon, and updating the URL to point to a specific playground page aligns with the PR objective of improving the user experience and engagement.
228-230: Verify the impact of removing the "Permify Cloud" section.The removal of the entire section related to "Permify Cloud" from the navigation structure indicates a potential shift in focus away from that feature.
Please ensure that this change aligns with the overall product strategy and does not negatively impact the user experience or access to relevant documentation.
| Permify centrally position itself in your environment as a service, which consists | ||
|
|
There was a problem hiding this comment.
Fix the verb agreement.
The verb "position" does not agree with the singular subject "Permify".
Please update the sentence as follows:
-Permify centrally position itself in your environment as a service, which consists
+Permify centrally positions itself in your environment as a service, which consistsCommittable 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.
| Permify centrally position itself in your environment as a service, which consists | |
| Permify centrally positions itself in your environment as a service, which consists |
Tools
LanguageTool
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...thorization systems. Permify centrally position itself in your environment as a service...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
| * **Improve documentation:** Alongside our codebase, documentation is an important part of our open-source journey. We're trying to give the best DX possible to explain ourselves and Permify. And you can help with that by importing resources or adding new ones. | ||
| * **Contribute to playground:** Permify playground allows you to visualize and test your authorization logic. You can contribute to our playground by improving its user interface, fixing glitches, or adding new features. | ||
|
|
||
| You can find more details about contributions on [CONTRIBUTING.md](https://github.com/Permify/permify/blob/master/CONTRIBUTING.md). |
There was a problem hiding this comment.
Use the idiomatic preposition "to" with "contributions".
The preposition "to" is more commonly used with the word "contributions". The phrase "contributions to" is a more standard and idiomatic way to express the idea of providing details about contributing to a project.
Please update the sentence as follows:
-You can find more details about contributions on [CONTRIBUTING.md](https://github.com/Permify/permify/blob/master/CONTRIBUTING.md).
+You can find more details about contributions to [CONTRIBUTING.md](https://github.com/Permify/permify/blob/master/CONTRIBUTING.md).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.
| You can find more details about contributions on [CONTRIBUTING.md](https://github.com/Permify/permify/blob/master/CONTRIBUTING.md). | |
| You can find more details about contributions to [CONTRIBUTING.md](https://github.com/Permify/permify/blob/master/CONTRIBUTING.md). |
Tools
LanguageTool
[grammar] ~87-~87: The usual preposition for “contribution” is “to”. Did you mean “contributions to”?
Context: ...tures. You can find more details about contributions on [CONTRIBUTING.md](https://github.com/Pe...(ON_THE_NOVEL)
| 🔮 Create permissions and policies using [Permify's flexible authorization language](../getting-started/modeling) that is compatible with traditional roles and permissions (RBAC), arbitrary relations between users and objects (ReBAC), and attributes (ABAC). | ||
| 📍 **Centralize & Standardize Your Authorization** - Abstract your authorization logic from your codebase and application logic to easily reason, test, and debug your authorization. Treat your authorization as a sole entity and move faster within your core development. | ||
|
|
||
| 🔮 **Build Granular Permissions For Any Case You Have** - You can create granular (resource-specific, hierarchical, context aware, etc) permissions and policies using Permify's domain specific language that is compatible with RBAC, ReBAC and ABAC. |
There was a problem hiding this comment.
Fix the grammar and style issues.
Please address the following issues in the sentence:
- Add a period after the abbreviation "etc".
- Hyphenate "domain specific" when used as a modifier.
Apply the following changes:
-You can create granular (resource-specific, hierarchical, context aware, etc) permissions and policies using Permify's domain specific language that is compatible with RBAC, ReBAC and ABAC.
+You can create granular (resource-specific, hierarchical, context aware, etc.) permissions and policies using Permify's domain-specific language that is compatible with RBAC, ReBAC and ABAC.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.
| 🔮 **Build Granular Permissions For Any Case You Have** - You can create granular (resource-specific, hierarchical, context aware, etc) permissions and policies using Permify's domain specific language that is compatible with RBAC, ReBAC and ABAC. | |
| 🔮 **Build Granular Permissions For Any Case You Have** - You can create granular (resource-specific, hierarchical, context aware, etc.) permissions and policies using Permify's domain-specific language that is compatible with RBAC, ReBAC and ABAC. |
Tools
LanguageTool
[style] ~42-~42: In American English, abbreviations like “etc.” require a period.
Context: ...-specific, hierarchical, context aware, etc) permissions and policies using Permify...(ETC_PERIOD)
[uncategorized] ~42-~42: When ‘domain-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...ermissions and policies using Permify's domain specific language that is compatible with RBAC, ...(SPECIFIC_HYPHEN)
| You can get immediate help on our Discord channel. This can be any kind of question-related to Permify, authorization, or authentication and identity management. We'd love to discuss anything related to access control space. | ||
| You can get immediate help on our [Discord Community](https://discord.com/invite/n6KfzYxhPp). This can be any kind of question-related to Permify, authorization, or authentication and identity management. We'd love to discuss anything related to access control space. | ||
|
|
||
| For feature requests, bugs, or any improvements you can always open an [issue](https://github.com/permify/permify/issues). |
There was a problem hiding this comment.
Consider adding a comma for clarity.
To improve clarity and avoid ambiguity, consider adding a comma before "or any improvements" according to the serial comma (Oxford comma) rule.
-For feature requests, bugs, or any improvements you can always open an (https://github.com/permify/permify/issues).
+For feature requests, bugs, or any improvements, you can always open an (https://github.com/permify/permify/issues).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.
| For feature requests, bugs, or any improvements you can always open an [issue](https://github.com/permify/permify/issues). | |
| For feature requests, bugs, or any improvements, you can always open an [issue](https://github.com/permify/permify/issues). |
Tools
LanguageTool
[uncategorized] ~79-~79: A comma might be missing here.
Context: ...ce. For feature requests, bugs, or any improvements you can always open an [issue](https://...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs: update content in intro and add sign up
Summary by CodeRabbit
New Features
Documentation
Style