Skip to content

W-18282485 Cursor suggestions for short descriptions (POC) #397

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.

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

Open
wants to merge 6 commits into
base: latest
Choose a base branch
from

Conversation

hannanelson
Copy link
Contributor

Writer's Quality Checklist

Before merging your PR, did you:

  • Run spell checker
  • Run link checker to check for broken xrefs
  • Check for orphan files
  • Perform a local build and do a final visual check of your content, including checking for:
    • Broken images
    • Dead links
    • Correct rendering of partials if they are used in your content
    • Formatting issues, such as:
      • Misnumbered ordered lists (steps) or incorrectly nested unordered lists
      • Messed up tables
      • Proper indentation
      • Correct header levels
  • Receive final review and signoff from:
    • Technical SME
    • Product Manager
    • Editor or peer reviewer
    • Reporter, if this content is in response to a reported issue (internal or external feedback)
  • If applicable, verify that the software actually got released

@hannanelson hannanelson requested review from valkyrie69 and a team as code owners May 1, 2025 21:20
@hannanelson
Copy link
Contributor Author

I used this prompt with Cursor and the gemini-2.5-pro-exp-03-25 model

Check all .adoc files in the pages folder to see if the short description (paragraph after the H1 heading) follows these guidelines:

  • Each short description should be at least 2 to 4 sentences that summarize the topic and build on the title without repeating it.
    -Put the most relevant language and keywords in the first 155 characters.
    -Summarize the key information in the topic
  • Use active voice
  • Highlight the customer benefit or user's main job.
    -Use simple, concise, declarative sentences.
    -Avoid self-referential phrases like "This topic describes..."
    -Don’t introduce a list or an image, and don’t use “these” or “the following".

@@ -1,6 +1,6 @@
= Enabling or Disabling Invocable Actions in the Salesforce Org

When the invocable actions capability is enabled by the Salesforce admin in Salesforce, MuleSoft automation developers can publish invocable actions directly from their Robotic Process Automations (RPA) and Composer flows to the connected Salesforce org.
Allow MuleSoft automation developers to directly publish invocable actions from RPA and Composer flows into a connected Salesforce org. This capability is controlled by the Salesforce administrator within the Salesforce Setup interface. Enabling this feature streamlines the process of making MuleSoft automations available for use within Salesforce workflows.
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't want to spell out RPA like in the original?

@@ -5,7 +5,7 @@ endif::[]
:keywords: anypoint platform, permissions, configuring
:page-aliases: anypoint-platform-for-apis-administration.adoc

Access Management enables you to xref:managing-your-account.adoc#how-to-create-your-account[create your Anypoint Platform account] and configure your user profile.
Control user access, manage organizational structures, and configure security settings within Anypoint Platform using Access Management. Define how users authenticate via internal credentials or external identity providers (IdPs) using SAML/OIDC for single sign-on (SSO), and enforce multi-factor authentication (MFA). Organize resources and permissions through business groups, environments, and the Teams feature to ensure users and client applications have appropriate access levels.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice!

@@ -1,6 +1,6 @@
= Managing Capabilities for a Connected Salesforce Organization

When you establish a tenant relationship and enable the connection between your Anypoint Platform organization and a trusted Salesforce organization, you can enable and disable capabilities associated with the Salesforce organization.
Control the integration between your Anypoint Platform and Salesforce organizations by managing specific capabilities. After establishing a trusted connection, selectively enable or disable features like Einstein Activity Capture or Invocable Actions based on your business needs. This ensures you only expose the necessary functionality for the integration.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Control the integration between your Anypoint Platform and Salesforce organizations by managing specific capabilities. After establishing a trusted connection, selectively enable or disable features like Einstein Activity Capture or Invocable Actions based on your business needs. This ensures you only expose the necessary functionality for the integration.
Control the integration between your Anypoint Platform and Salesforce organizations by managing specific capabilities. After establishing a trusted connection, selectively enable or disable features like Einstein or Invocable Actions based on your business needs.

@@ -1,6 +1,6 @@
= Managing Connected Salesforce Orgs

As an Anypoint Platform organization administrator, you can enable, remove, and repair connections, and edit the name of Salesforce organizations.
Maintain the connections between your Anypoint Platform organization and trusted Salesforce organizations. As an administrator, learn how to enable newly established tenant relationships to activate cross-platform features. You can also repair connections if Salesforce domain details change, edit the displayed Salesforce organization name for clarity, or permanently remove connections when they are no longer needed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Maintain the connections between your Anypoint Platform organization and trusted Salesforce organizations. As an administrator, learn how to enable newly established tenant relationships to activate cross-platform features. You can also repair connections if Salesforce domain details change, edit the displayed Salesforce organization name for clarity, or permanently remove connections when they are no longer needed.
Maintain the connections between your Anypoint Platform organization and trusted Salesforce organizations. Enable newly established tenant relationships to activate cross-platform features. You can also repair connections if Salesforce domain details change, edit the displayed Salesforce organization name for clarity, or permanently remove connections when they are no longer needed.

@@ -5,7 +5,7 @@ endif::[]
:keywords: anypoint platform, permissions, configuring, accounts, roles
:page-aliases: managing-accounts-roles-and-permissions.adoc

This section explains how permissions work across different products and APIs managed from the Anypoint Platform.
Control user access across Anypoint Platform by understanding and managing permissions effectively. Assign appropriate capabilities through roles (deprecated) or the recommended Teams feature to regulate access to specific products, APIs, environments, and business groups. Properly configured permissions ensure users have the necessary access while maintaining security and compliance.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Control user access across Anypoint Platform by understanding and managing permissions effectively. Assign appropriate capabilities through roles (deprecated) or the recommended Teams feature to regulate access to specific products, APIs, environments, and business groups. Properly configured permissions ensure users have the necessary access while maintaining security and compliance.
Control user access across Anypoint Platform by understanding and managing permissions effectively. Assign appropriate capabilities through the Teams feature to regulate access to specific products, APIs, environments, and business groups. Properly configured permissions ensure users have the necessary access while maintaining security and compliance.

@@ -1,6 +1,6 @@
= SSO Prerequisites and Limitations

When using SSO within Anypoint Platform, there are some prerequisites and limitations to be aware of.
Prepare for a successful single sign-on (SSO) implementation by understanding the necessary prerequisites and potential limitations within Anypoint Platform. Ensure your identity provider (IdP) is correctly configured to send required user attributes and handle signed/encrypted SAML assertions. Be aware of specific client behaviors and limitations related to session timeouts, external identity scope, and user management when using SSO.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Prepare for a successful single sign-on (SSO) implementation by understanding the necessary prerequisites and potential limitations within Anypoint Platform. Ensure your identity provider (IdP) is correctly configured to send required user attributes and handle signed/encrypted SAML assertions. Be aware of specific client behaviors and limitations related to session timeouts, external identity scope, and user management when using SSO.
Prepare for a successful single sign-on (SSO) implementation by understanding the necessary prerequisites and potential limitations within Anypoint Platform. Ensure your identity provider (IdP) is correctly configured to send required user attributes and handle signed and encrypted SAML assertions. Be aware of specific client behaviors and limitations related to session timeouts, external identity scope, and user management when using SSO.

@@ -1,6 +1,6 @@
= Example Teams Structure

Imagine that your organization, Acme, includes a team called Engineering that contains smaller teams that focus on building specific components. The Identity and DevOps teams are specialized teams within the larger Engineering team.
Understand how to structure teams effectively using a practical example. See how a hypothetical organization, Acme, uses a main Engineering team with specialized Identity and DevOps sub-teams to manage permissions efficiently. This hierarchical approach helps delegate access based on specific roles and responsibilities.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Understand how to structure teams effectively using a practical example. See how a hypothetical organization, Acme, uses a main Engineering team with specialized Identity and DevOps sub-teams to manage permissions efficiently. This hierarchical approach helps delegate access based on specific roles and responsibilities.
See how a hypothetical organization, Acme, uses a main Engineering team with specialized Identity and DevOps sub-teams to manage permissions and structure teams effectively in this practical example. This hierarchical approach helps delegate access based on specific roles and responsibilities.

@@ -1,6 +1,6 @@
= View a SAML Response in the Browser

To view your SAML response in a browser, perform a single sign-on (SSO) and use the developer tools in your browser to find the bearer token and SAML response.
Troubleshoot single sign-on (SSO) issues by capturing the SAML response directly within your web browser. Perform an SSO login attempt and then use your browser's developer tools to inspect the network traffic. This allows you to find and analyze the SAML assertion details, which is essential for diagnosing configuration problems or providing information to support.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Troubleshoot single sign-on (SSO) issues by capturing the SAML response directly within your web browser. Perform an SSO login attempt and then use your browser's developer tools to inspect the network traffic. This allows you to find and analyze the SAML assertion details, which is essential for diagnosing configuration problems or providing information to support.
Troubleshoot single sign-on (SSO) issues by capturing the SAML response directly within your web browser. Attempt an SSO login and then use your browser's developer tools to inspect the network traffic. This allows you to find and analyze the SAML assertion details, which is essential for diagnosing configuration problems or providing information to support.

@@ -1,6 +1,6 @@
= Trusted Salesforce Organizations

Enable cross-platform features between your Anypoint Platform organization and a trusted Salesforce organization (tenant) by establishing a connection between them.
Connect your Anypoint Platform organization with one or more trusted Salesforce organizations (tenants) to enable powerful cross-platform features. Establishing this tenant relationship allows seamless integration, such as syncing APIs via API Catalog, publishing invocable actions from RPA or Composer, and enhancing developer tools with Einstein. Manage these connections to control which features are active between the platforms.
Copy link
Contributor

Choose a reason for hiding this comment

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

Spell out RPA?
Is it okay to use words like "powerful" and "seamless?" I don't mind, but writer.ai usually raps my knuckles.

@@ -1,6 +1,6 @@
= Managing Users

As an administrator of your root organization, you can enable, disable, or delete users, assign permissions to users, and edit a user's settings.
Manage user accounts within your Anypoint Platform root organization as an administrator. Learn how to invite new users, enable or disable existing accounts, and assign or revoke permissions individually or through teams/roles. Understand the implications of deleting users and how to manage pending invitations or reset user passwords.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Manage user accounts within your Anypoint Platform root organization as an administrator. Learn how to invite new users, enable or disable existing accounts, and assign or revoke permissions individually or through teams/roles. Understand the implications of deleting users and how to manage pending invitations or reset user passwords.
Manage user accounts within your Anypoint Platform root organization as an administrator. Learn how to invite new users, enable or disable existing accounts, and assign or revoke permissions individually or through teams. Understand the implications of deleting users and how to manage pending invitations or reset user passwords.

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