chore: fix typos across all docs #2727
Conversation
📝 WalkthroughWalkthroughThis PR applies editorial corrections across 30+ documentation files, addressing grammar issues, spelling errors, punctuation inconsistencies, subject-verb agreement, and capitalization standardization. No functional changes, public API modifications, or control flow alterations are introduced. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks✅ Passed checks (3 passed)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI Agents
In @docs/use-cases/rebac.mdx:
- Line 128: The sentence incorrectly states that nested relations are accessed
"with a comma"; update the phrasing to say Permify Schema uses dot notation for
nested relations and give the concrete examples shown (e.g., parent.admin,
parent.member) so the line reads that `parent` can reach nested relations via
dot notation (e.g., parent.admin, parent.member).
🧹 Nitpick comments (1)
docs/setting-up/installation/brew.mdx (1)
60-60: Consider removing space before question mark for consistency.Line 60 contains a space before the question mark, which is inconsistent with the punctuation normalization mentioned in the PR summary.
🔎 Suggested fix
-### Need any help ? +### Need any help?
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (33)
docs/api-reference/bundle/write-bundle.mdxdocs/api-reference/introduction.mdxdocs/cloud/intro.mdxdocs/development.mdxdocs/getting-started/enforcement.mdxdocs/getting-started/examples/facebook-groups.mdxdocs/getting-started/examples/google-docs.mdxdocs/getting-started/examples/instagram.mdxdocs/getting-started/examples/mercury.mdxdocs/getting-started/examples/notion.mdxdocs/getting-started/modeling.mdxdocs/getting-started/quickstart.mdxdocs/getting-started/sync-data.mdxdocs/getting-started/testing.mdxdocs/integrations/data-sync.mdxdocs/migration/v1.0-v1.1.mdxdocs/modeling-guides/rbac/global-roles.mdxdocs/operations/cache.mdxdocs/operations/contextual-tuples.mdxdocs/operations/snap-tokens.mdxdocs/permify-overview/authorization-service.mdxdocs/permify-overview/faqs.mdxdocs/permify-overview/intro.mdxdocs/quickstart.mdxdocs/setting-up/installation/brew.mdxdocs/setting-up/installation/helm.mdxdocs/setting-up/installation/intro.mdxdocs/snippets/snippet-intro.mdxdocs/use-cases/abac.mdxdocs/use-cases/custom-roles.mdxdocs/use-cases/multi-tenancy.mdxdocs/use-cases/rbac.mdxdocs/use-cases/rebac.mdx
🧰 Additional context used
🪛 LanguageTool
docs/permify-overview/faqs.mdx
[locale-violation] ~72-~72: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...nfigure it using this Write Schema API. Afterwards, you can use the preferred version of t...
(AFTERWARDS_US)
docs/operations/cache.mdx
[style] ~98-~98: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...rchitecture for your permission system. Feel free to [schedule a consultation call with one ...
(FEEL_FREE_TO_STYLE_ME)
docs/getting-started/enforcement.mdx
[style] ~63-~63: Consider a more concise word here.
Context: ...ify implements several cache mechanisms in order to achieve low latency in scaled distribut...
(IN_ORDER_TO_PREMIUM)
docs/api-reference/introduction.mdx
[style] ~65-~65: Consider a more concise word here.
Context: ...ify implements several cache mechanisms in order to achieve low latency in scaled distribut...
(IN_ORDER_TO_PREMIUM)
docs/permify-overview/authorization-service.mdx
[style] ~25-~25: Consider using a more concise synonym.
Context: ...zed authorization service** that offers a variety of binding and crafting options to secure ...
(A_VARIETY_OF)
[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 store you...
(REP_NEED_TO_VB)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Scan Container for Vulnerabilities
- GitHub Check: Test with Coverage
- GitHub Check: Analyze (go)
- GitHub Check: Test with Coverage
🔇 Additional comments (53)
docs/setting-up/installation/brew.mdx (1)
19-19: LGTM! Grammar correction is accurate.The typo fix from "rather then" to "rather than" is correct and improves documentation quality.
docs/integrations/data-sync.mdx (1)
147-147: Code is correct. Line 147 shows the properpermify-synccommand with no remaining typos in the codebase.docs/development.mdx (1)
25-25: LGTM!The grammar fix correctly adds "where" to form a proper relative clause: "Go to where the docs are located."
docs/modeling-guides/rbac/global-roles.mdx (1)
63-63: LGTM!Correct spelling fix ("separate"), proper comma usage, and appropriate hyphenation of compound adjective ("vendor-specific").
docs/migration/v1.0-v1.1.mdx (1)
5-5: LGTM!Important content correction—the migration guide now correctly references Permify versions instead of an unrelated library.
docs/getting-started/examples/facebook-groups.mdx (1)
536-538: LGTM!Correct punctuation fix (removing space before question mark) and improved concluding sentence.
docs/quickstart.mdx (1)
8-8: LGTM!Correctly removed the duplicated "and" word.
docs/getting-started/quickstart.mdx (5)
93-104: LGTM!Clean editorial improvements with proper punctuation and formatting consistency.
112-115: LGTM!Grammar and punctuation improvements are correct.
134-134: LGTM!Editorial improvement for clarity.
191-193: LGTM!Punctuation and phrasing improvements are correct.
244-248: LGTM!Consistent heading punctuation fix ("Need any help?") matching other documentation files in this PR.
docs/snippets/snippet-intro.mdx (1)
2-2: LGTM!Correct subject-verb agreement fix: "This is a principle that applies" (singular subject requires singular verb).
docs/setting-up/installation/intro.mdx (1)
38-38: LGTM! Grammar corrections are accurate.Both changes improve the documentation:
- Correct article usage: "an EKS" (EKS begins with a vowel sound)
- Removed redundant "with" from "with using"
Also applies to: 48-48
docs/getting-started/examples/notion.mdx (1)
539-541: LGTM! Punctuation and context fixes are correct.The punctuation correction (removing space before
?) and the context-specific text update both improve the documentation quality.docs/getting-started/testing.mdx (1)
11-11: LGTM! Proper capitalization and punctuation applied.All changes correctly standardize:
- "GitHub" (proper brand capitalization)
- "YAML" (acronym should be uppercase)
- Punctuation (no space before
?)Also applies to: 14-14, 19-19, 38-38, 43-43, 302-302
docs/getting-started/examples/instagram.mdx (1)
326-328: LGTM! Punctuation and context improvements.The punctuation correction and Instagram-specific context update both enhance documentation consistency.
docs/setting-up/installation/helm.mdx (1)
17-17: LGTM! Multiple grammar corrections applied correctly.The sentence now has proper grammar with:
- Missing verb "is" added
- Modern spelling "prerequisite" (unhyphenated)
- Correct article usage "a Kubernetes Cluster"
docs/api-reference/bundle/write-bundle.mdx (1)
14-20: LGTM! Clean editorial improvements.The grammar and phrasing refinements improve readability throughout this section.
docs/getting-started/examples/mercury.mdx (2)
13-13: LGTM! Correct grammar and spelling fixes.Fixed pluralization ("two admins") and typo correction ("from" instead of "form").
159-161: LGTM! Punctuation and grammar improvements.Standardized punctuation (removed space before "?") and added the article "the" for proper grammar.
docs/api-reference/introduction.mdx (4)
13-13: LGTM! Improved grammar.Better sentence structure with "Consists of tenant operations such as..."
59-59: LGTM! Proper capitalization.Standardized to "Golang" and "Node.js" following conventional styling for these technologies.
65-65: LGTM! Spelling correction.Fixed typo: "Mechanisms" (was "Mechanisims").
92-92: LGTM! Punctuation standardization.Removed space before question mark, following standard English punctuation rules.
docs/operations/snap-tokens.mdx (1)
22-24: LGTM! Grammar improvements.The phrasing refinements improve clarity and readability in the Snap Tokens usage section.
docs/cloud/intro.mdx (5)
66-66: LGTM! Improved phrasing.Added "eventually" for better temporal clarity.
80-80: LGTM! Spelling and grammar correction.Fixed "best practices" (was "best practise") - correct spelling and proper plural form.
94-94: LGTM! Grammar correction.Fixed prepositional phrase: "Similar to deploying" (was "Similar deploying").
158-158: LGTM! Subject-verb agreement fix.Corrected to singular "deployment record is labeled" for proper grammar.
230-244: LGTM! Grammar improvements.Minor phrasing refinements improve sentence flow and clarity.
docs/getting-started/examples/google-docs.mdx (1)
48-48: LGTM! Editorial improvements enhance clarity.The grammar and consistency fixes improve the documentation quality without altering any functional content.
Also applies to: 193-193, 211-211, 233-233
docs/getting-started/sync-data.mdx (1)
43-47: LGTM! Grammar and clarity improvements.The corrections to subject-verb agreement, article usage, and sentence clarity enhance the documentation without changing any technical content.
Also applies to: 53-53, 182-182, 365-365, 462-462
docs/getting-started/modeling.mdx (1)
16-16: LGTM! Comprehensive editorial polish.The grammar corrections and clarity improvements throughout the document enhance readability while preserving all technical content and examples.
Also applies to: 30-30, 69-69, 76-78, 91-91, 95-95, 140-140, 163-163, 168-168, 201-201, 215-215, 243-243, 421-421, 462-462
docs/permify-overview/authorization-service.mdx (1)
19-19: LGTM! Grammar and punctuation corrections.The editorial fixes improve documentation quality, including the article correction ("an centralized"), heading capitalization, and punctuation normalization (removing space before question mark).
Also applies to: 25-25, 29-29, 39-39, 41-41, 55-57, 82-82, 88-88, 92-92, 96-96
docs/use-cases/abac.mdx (1)
637-637: LGTM! Punctuation correction.The removal of the space before the question mark in the heading aligns with standard punctuation conventions and matches similar corrections throughout the PR.
docs/use-cases/rebac.mdx (2)
62-62: Grammar improvement looks good.Removing the comma after the entity name improves readability in the bullet point.
421-421: Punctuation normalization approved.Removing the space before the question mark aligns with standard markdown heading conventions and PR-wide editorial improvements across the documentation.
docs/use-cases/custom-roles.mdx (1)
72-72: Heading punctuation normalized.Removing the space before the question mark improves consistency with standard markdown formatting and aligns with similar corrections across the documentation.
docs/permify-overview/intro.mdx (1)
21-21: Heading punctuation normalized.Removing the space before the question mark improves consistency with standard markdown formatting.
docs/use-cases/multi-tenancy.mdx (1)
178-178: LGTM!Correctly removes the extraneous space before the question mark, following standard English punctuation rules.
docs/use-cases/rbac.mdx (1)
123-123: LGTM!Punctuation correction is consistent with the other documentation files in this PR.
docs/operations/cache.mdx (1)
98-98: LGTM!Grammar corrections are accurate: added missing "to" after "happy," fixed word order, and added the article "the" before "right architecture."
docs/getting-started/enforcement.mdx (3)
57-57: LGTM!Proper capitalization of technology names (Golang, Node.js) aligns with official naming conventions.
63-63: LGTM!Section reference updated correctly.
90-90: LGTM!Punctuation correction is consistent with other documentation files.
docs/permify-overview/faqs.mdx (5)
13-13: LGTM!Fixed subject-verb agreement in the heading ("How Are Access Decisions Evaluated?").
17-19: LGTM!Grammar improvements: proper sentence-start capitalization ("At a high level") and corrected verb form ("Permify Engine computes").
64-72: LGTM!Multiple grammar and clarity improvements throughout this section. The use of "Afterwards" (line 72) is acceptable in both American and British English, though "Afterward" is slightly preferred in American English—this is a minor stylistic preference.
84-84: LGTM!Question heading grammar improved with proper article usage.
98-113: LGTM!Grammar and clarity improvements are accurate, including better sentence structure and proper heading format.
docs/operations/contextual-tuples.mdx (2)
23-23: LGTM!Added the missing article "the" before "ability."
233-233: LGTM!Punctuation correction is consistent with other documentation files.
| ``` | ||
|
|
||
| Since `parent` represents the parent organization of a repository. It can reach repositories parent organization relations with comma. So, | ||
| Since `parent` represents the parent organization of a repository, it can reach the repository's parent organization relations with a comma. So, |
There was a problem hiding this comment.
Critical: Fix incorrect syntax description for nested relations.
Permify Schema uses dot notation to access nested relations (e.g., parent.admin, parent.member), not commas. The phrase "with a comma" contradicts the correct examples shown immediately below on lines 130–134. This creates confusion for readers learning the schema syntax.
🔎 Proposed fix
- Since `parent` represents the parent organization of a repository, it can reach the repository's parent organization relations with a comma. So,
+ Since `parent` represents the parent organization of a repository, you can access the repository's parent organization relations using dot notation. So,📝 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.
| Since `parent` represents the parent organization of a repository, it can reach the repository's parent organization relations with a comma. So, | |
| Since `parent` represents the parent organization of a repository, you can access the repository's parent organization relations using dot notation. So, |
🤖 Prompt for AI Agents
In @docs/use-cases/rebac.mdx at line 128, The sentence incorrectly states that
nested relations are accessed "with a comma"; update the phrasing to say Permify
Schema uses dot notation for nested relations and give the concrete examples
shown (e.g., parent.admin, parent.member) so the line reads that `parent` can
reach nested relations via dot notation (e.g., parent.admin, parent.member).
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI Agents
In @docs/cloud/intro.mdx:
- Line 94: Replace the sentence fragment and remove the leading conjunction by
rewriting the two phrases into a complete sentence or two proper sentences;
e.g., change "Similar to deploying your Vercel application with GitHub Actions.
And we show these deployments in the **Deployments** view." to a full sentence
like "This is similar to deploying your Vercel application with GitHub Actions,
and we show these deployments in the **Deployments** view." or split into "This
is similar to deploying your Vercel application with GitHub Actions. We show
these deployments in the **Deployments** view."
- Line 158: Edit the sentence "In the above example we directly pushed our
change to the master branch. And this deployment record is labeled as
**production** by default." by adding a comma after the introductory phrase and
removing the sentence-initial "And" (e.g., combine into: "In the above example,
we directly pushed our change to the master branch, and this deployment record
is labeled as **production** by default.").
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/cloud/intro.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Test with Coverage
- GitHub Check: Analyze (go)
- GitHub Check: Test with Coverage
🔇 Additional comments (4)
docs/cloud/intro.mdx (4)
66-66: LGTM!The sentence is clear and grammatically correct.
80-80: LGTM!The best practice statement is well articulated.
230-230: LGTM!The sentence is grammatically correct and clearly explains the importance.
244-244: LGTM!The sentence is clear, grammatically correct, and effectively describes the autoscaling behavior.
| With **Schema Management GitOps Workflow**, you can now automatically deploy authorization models to Permify directly from your GitHub repository. | ||
|
|
||
| Similar deploying your Vercel application with GitHub Actions. And we show these deployments in the **Deployments** view. | ||
| Similar to deploying your Vercel application with GitHub Actions. And we show these deployments in the **Deployments** view. |
There was a problem hiding this comment.
Fix sentence fragment and conjunction at start.
The line contains two grammar issues:
- "Similar to deploying your Vercel application with GitHub Actions." is a sentence fragment.
- Starting the next sentence with "And" is discouraged in formal documentation.
🔎 Suggested fix
-Similar to deploying your Vercel application with GitHub Actions. And we show these deployments in the **Deployments** view.
+Similar to deploying your Vercel application with GitHub Actions, we show these deployments in the **Deployments** view.📝 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.
| Similar to deploying your Vercel application with GitHub Actions. And we show these deployments in the **Deployments** view. | |
| Similar to deploying your Vercel application with GitHub Actions, we show these deployments in the **Deployments** view. |
🤖 Prompt for AI Agents
In @docs/cloud/intro.mdx at line 94, Replace the sentence fragment and remove
the leading conjunction by rewriting the two phrases into a complete sentence or
two proper sentences; e.g., change "Similar to deploying your Vercel application
with GitHub Actions. And we show these deployments in the **Deployments**
view." to a full sentence like "This is similar to deploying your Vercel
application with GitHub Actions, and we show these deployments in the
**Deployments** view." or split into "This is similar to deploying your Vercel
application with GitHub Actions. We show these deployments in the
**Deployments** view."
| ### Schema Staging | ||
|
|
||
| In above example we directly pushed our change to master branch. And this deployment records labeled as **production** by default. | ||
| In the above example we directly pushed our change to the master branch. And this deployment record is labeled as **production** by default. |
There was a problem hiding this comment.
Fix missing comma and sentence starting with conjunction.
The line has two grammar issues:
- Missing comma after the introductory phrase "In the above example".
- Starting a sentence with "And" is discouraged in formal documentation.
🔎 Suggested fix
-In the above example we directly pushed our change to the master branch. And this deployment record is labeled as **production** by default.
+In the above example, we directly pushed our change to the master branch. This deployment record is labeled as **production** by default.📝 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.
| In the above example we directly pushed our change to the master branch. And this deployment record is labeled as **production** by default. | |
| In the above example, we directly pushed our change to the master branch. This deployment record is labeled as **production** by default. |
🤖 Prompt for AI Agents
In @docs/cloud/intro.mdx at line 158, Edit the sentence "In the above example we
directly pushed our change to the master branch. And this deployment record is
labeled as **production** by default." by adding a comma after the introductory
phrase and removing the sentence-initial "And" (e.g., combine into: "In the
above example, we directly pushed our change to the master branch, and this
deployment record is labeled as **production** by default.").
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2727 +/- ##
==========================================
- Coverage 82.56% 82.55% -0.01%
==========================================
Files 74 74
Lines 8125 8125
==========================================
- Hits 6708 6707 -1
- Misses 902 903 +1
Partials 515 515 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…PR 2708, which also includes typo fixes
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/permify-overview/faqs.mdx (1)
70-72: Grammar improvements look good; consider dialect consistency.The sentence restructuring improves readability. However, "Afterwards" on line 72 is British English. If the project follows American English conventions, consider using "Afterward" instead.
🔎 Optional: Align with American English dialect
-As an example, when a new feature arises and related permissions are created, you need to change the schema (rewrite it with the new permission) then configure it using this Write Schema API. Afterwards, you can use the preferred version of the schema in your API requests with **schema_version**. If you do not prefer to use **schema_version** params in API calls Permify automatically gets the latest schema on API calls. +As an example, when a new feature arises and related permissions are created, you need to change the schema (rewrite it with the new permission) then configure it using this Write Schema API. Afterward, you can use the preferred version of the schema in your API requests with **schema_version**. If you do not prefer to use **schema_version** params in API calls Permify automatically gets the latest schema on API calls.Based on static analysis hints.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
docs/getting-started/examples/facebook-groups.mdxdocs/getting-started/examples/google-docs.mdxdocs/getting-started/quickstart.mdxdocs/getting-started/sync-data.mdxdocs/permify-overview/authorization-service.mdxdocs/permify-overview/faqs.mdx
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/getting-started/sync-data.mdx
- docs/getting-started/quickstart.mdx
- docs/getting-started/examples/google-docs.mdx
- docs/getting-started/examples/facebook-groups.mdx
🧰 Additional context used
🪛 LanguageTool
docs/permify-overview/authorization-service.mdx
[style] ~25-~25: Consider using a more concise synonym.
Context: ...zed authorization service** that offers a variety of binding and crafting options to secure ...
(A_VARIETY_OF)
[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 store you...
(REP_NEED_TO_VB)
docs/permify-overview/faqs.mdx
[locale-violation] ~72-~72: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...nfigure it using this Write Schema API. Afterwards, you can use the preferred version of t...
(AFTERWARDS_US)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Test with Coverage
- GitHub Check: Scan Container for Vulnerabilities
- GitHub Check: Analyze (go)
- GitHub Check: Test with Coverage
🔇 Additional comments (6)
docs/permify-overview/authorization-service.mdx (2)
19-19: LGTM! Grammar fixes are correct.The article corrections from "an" to "a" before "centralized" are grammatically accurate, as "centralized" begins with a consonant sound.
Also applies to: 29-29
7-98: Editorial improvements look good.The typo and grammar corrections throughout this documentation file improve clarity and professionalism without altering meaning or functionality. The changes align well with the PR objectives.
docs/permify-overview/faqs.mdx (4)
13-13: LGTM: Grammar fix improves question structure.The heading now follows proper interrogative form with the auxiliary verb "Are."
17-23: LGTM: Grammar improvements enhance clarity.These changes correct verb forms and improve sentence flow, making the access decision evaluation explanation clearer.
64-66: LGTM: Improved explanation of decision logic.The grammatical refinements make the explanation of "or" and "and" relationship evaluation more precise and easier to follow.
84-84: LGTM: Consistent grammar fixes throughout.The heading corrections (lines 84, 113) improve question structure, and the phrasing refinements (lines 98, 111) enhance readability.
Also applies to: 98-98, 111-113
This is a first pass at fixing any typos or grammar errors in the docs.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.