Skip to content

Conversation

@EgeAytin
Copy link
Member

@EgeAytin EgeAytin commented Jan 15, 2025

docs: update schedule a call messaging

Summary by CodeRabbit

  • Documentation
    • Updated support contact information across multiple documentation files
    • Replaced references to "Permify engineers" with "account executives"
    • Modified assistance scheduling language to emphasize "consultation call"

@coderabbitai
Copy link

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request involves a consistent update across multiple documentation files, specifically changing the text related to scheduling assistance. The modification replaces the phrase "schedule a call with one of our Permify engineers" with "schedule a consultation call with one of our account executives" in various documentation pages. This change appears to be a strategic shift in how customer support or engagement is positioned, emphasizing consultation and account management over direct technical engineering support.

Changes

File Path Change Summary
docs/api-reference/introduction.mdx Updated assistance contact text from engineers to account executives
docs/docs/permify-overview/authorization-service.md Modified support contact description
docs/docs/permify-overview/intro.md Changed assistance contact terminology
docs/docs/playground.md Updated support contact details
docs/getting-started/* Multiple files updated with new consultation call text
docs/modeling-guides/rbac/custom-roles.mdx Revised support contact information
docs/operations/* Updated assistance scheduling text
docs/use-cases/* Consistent changes to support contact description

Poem

🐰 A Rabbit's Documentation Delight

From engineers to execs so bright,
Our docs now dance with consultative might!
A call, a chat, a helpful hand,
Permify's support across the land 🌈
Words shift, but our passion stays tight! 📞


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?

❤️ 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.
    • Generate unit testing code for this file.
    • 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. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • 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 src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

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

Documentation and Community

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Nitpick comments (2)
docs/use-cases/custom-roles.mdx (1)

74-74: Add comma after "Alternatively"

For better readability and proper punctuation, add a comma after "Alternatively".

-Alternatively you can join our [discord community]
+Alternatively, you can join our [discord community]
🧰 Tools
🪛 LanguageTool

[typographical] ~74-~74: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

docs/operations/cache.mdx (1)

98-98: Consider more professional phrasing

The phrase "feel free to" could be replaced with more professional alternatives.

-Our team is happy help you to structure right architecture for your permission system. Feel free to [schedule a consultation call
+Our team is happy help you to structure right architecture for your permission system. We invite you to [schedule a consultation call
🧰 Tools
🪛 LanguageTool

[style] ~98-~98: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...rchitecture for your permission system. Feel free to [schedule a consultation call with one ...

(FEEL_FREE_TO_STYLE_ME)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7b3d083 and 79a8486.

📒 Files selected for processing (19)
  • docs/api-reference/introduction.mdx (1 hunks)
  • docs/docs/permify-overview/authorization-service.md (1 hunks)
  • docs/docs/permify-overview/intro.md (1 hunks)
  • docs/docs/playground.md (1 hunks)
  • docs/getting-started/enforcement.mdx (1 hunks)
  • docs/getting-started/examples/facebook-groups.mdx (1 hunks)
  • docs/getting-started/examples/google-docs.mdx (1 hunks)
  • docs/getting-started/examples/notion.mdx (1 hunks)
  • docs/getting-started/quickstart.mdx (1 hunks)
  • docs/getting-started/testing.mdx (1 hunks)
  • docs/modeling-guides/rbac/custom-roles.mdx (1 hunks)
  • docs/operations/cache.mdx (1 hunks)
  • docs/operations/contextual-tuples.mdx (1 hunks)
  • docs/permify-overview/authorization-service.mdx (1 hunks)
  • docs/use-cases/abac.mdx (1 hunks)
  • docs/use-cases/custom-roles.mdx (1 hunks)
  • docs/use-cases/multi-tenancy.mdx (1 hunks)
  • docs/use-cases/rbac.mdx (1 hunks)
  • docs/use-cases/rebac.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (12)
  • docs/docs/permify-overview/intro.md
  • docs/use-cases/multi-tenancy.mdx
  • docs/api-reference/introduction.mdx
  • docs/docs/permify-overview/authorization-service.md
  • docs/permify-overview/authorization-service.mdx
  • docs/operations/contextual-tuples.mdx
  • docs/getting-started/examples/google-docs.mdx
  • docs/getting-started/enforcement.mdx
  • docs/getting-started/examples/facebook-groups.mdx
  • docs/docs/playground.md
  • docs/getting-started/testing.mdx
  • docs/getting-started/examples/notion.mdx
🧰 Additional context used
🪛 LanguageTool
docs/getting-started/quickstart.mdx

[typographical] ~250-~250: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

docs/modeling-guides/rbac/custom-roles.mdx

[typographical] ~126-~126: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

docs/operations/cache.mdx

[style] ~98-~98: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...rchitecture for your permission system. Feel free to [schedule a consultation call with one ...

(FEEL_FREE_TO_STYLE_ME)

docs/use-cases/abac.mdx

[typographical] ~639-~639: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

docs/use-cases/custom-roles.mdx

[typographical] ~74-~74: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

docs/use-cases/rbac.mdx

[typographical] ~125-~125: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

docs/use-cases/rebac.mdx

[typographical] ~423-~423: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (go)
  • GitHub Check: Test with Coverage
  • GitHub Check: Test with Coverage
🔇 Additional comments (6)
docs/use-cases/rbac.mdx (2)

125-125: Fix typo in "executives"

The word "executives" is misspelled as "executivess".

🧰 Tools
🪛 LanguageTool

[typographical] ~125-~125: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)


125-125: Add comma after "Alternatively"

For better readability and proper punctuation, add a comma after "Alternatively".

🧰 Tools
🪛 LanguageTool

[typographical] ~125-~125: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

docs/modeling-guides/rbac/custom-roles.mdx (2)

126-126: Fix typo in "executives"

The word "executives" is misspelled as "executivess".

🧰 Tools
🪛 LanguageTool

[typographical] ~126-~126: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)


126-126: Add comma after "Alternatively"

For better readability and proper punctuation, add a comma after "Alternatively".

🧰 Tools
🪛 LanguageTool

[typographical] ~126-~126: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

docs/getting-started/quickstart.mdx (2)

250-250: Fix typo in "executives"

The word "executives" is misspelled as "executivess".

🧰 Tools
🪛 LanguageTool

[typographical] ~250-~250: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)


250-250: Add comma after "Alternatively"

For better readability and proper punctuation, add a comma after "Alternatively".

🧰 Tools
🪛 LanguageTool

[typographical] ~250-~250: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

## Need any help ?

Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a call with one of our Permify engineers](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executivess](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo in "executives"

The word "executives" is misspelled as "executivess".

-[schedule a consultation call with one of our account executivess]
+[schedule a consultation call with one of our account executives]
📝 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
Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executivess](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executives](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
🧰 Tools
🪛 LanguageTool

[typographical] ~74-~74: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

## Need any help on Authorization ?

Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a call with one of our Permify engineers](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executivess](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo and add missing comma.

There are two minor issues in this line:

  1. "executivess" has an extra 's'
  2. A comma is needed after "Alternatively"
-Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executivess](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
+Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executives](https://calendly.com/d/cj79-kyf-b4z). Alternatively, you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
📝 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
Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executivess](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executives](https://calendly.com/d/cj79-kyf-b4z). Alternatively, you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
🧰 Tools
🪛 LanguageTool

[typographical] ~423-~423: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

## Need any help ?

Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a call with one of our Permify engineers](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executivess](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo and add missing comma.

The same issues appear in this file:

  1. "executivess" has an extra 's'
  2. A comma is needed after "Alternatively"
-Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executivess](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
+Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executives](https://calendly.com/d/cj79-kyf-b4z). Alternatively, you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
📝 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
Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executivess](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executives](https://calendly.com/d/cj79-kyf-b4z). Alternatively, you can join our [discord community](https://discord.com/invite/MJbUjwskdH) to discuss.
🧰 Tools
🪛 LanguageTool

[typographical] ~639-~639: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: ...](https://calendly.com/d/cj79-kyf-b4z). Alternatively you can join our [discord community](ht...

(RB_LY_COMMA)

@EgeAytin EgeAytin merged commit 0f2cf11 into master Jan 15, 2025
10 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants