Skip to content

Improve documentation clarity and grammar#1927

Open
Kalpiekanayake wants to merge 1 commit into
wso2:PEfrom
Kalpiekanayake:fix-doc-issue
Open

Improve documentation clarity and grammar#1927
Kalpiekanayake wants to merge 1 commit into
wso2:PEfrom
Kalpiekanayake:fix-doc-issue

Conversation

@Kalpiekanayake

Copy link
Copy Markdown

Description

This PR improves documentation clarity, grammar, and formatting across multiple administration guides.

Changes

  • Improved wording in the Asgardeo external IdP guide.
  • Fixed grammar, capitalization, and formatting issues in the Azure AD external IdP guide.
  • Improved clarity and readability in the workflow approval configuration guide.

Type of change

  • Change is only applicable for Developer view
  • Change is only applicable for Platform Engineer view
  • Change is applicable for both Developer and Platform Engineer views

Testing

  • Change is tested in Developer view
  • Change is tested in Platform Engineer view

Related issues

N/A

@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5817ce23-476b-4583-8132-2126512fc341

📥 Commits

Reviewing files that changed from the base of the PR and between ff5700a and 80cfbb1.

📒 Files selected for processing (3)
  • en/developer-docs/docs/administer/configure-an-external-idp/configure-asgardeo-as-an-external-idp.md
  • en/developer-docs/docs/administer/configure-an-external-idp/configure-azure-ad-as-an-external-idp.md
  • en/developer-docs/docs/administer/configure-approvals-for-choreo-workflows.md

📝 Walkthrough

Documentation Improvements

This pull request improves documentation clarity, grammar, and formatting across three administration guides in the Choreo development documentation:

  1. Asgardeo External IdP Configuration Guide: Updated prerequisite text for consistency and clarity, including standardized phrasing and formatting adjustments.

  2. Azure AD External IdP Configuration Guide: Enhanced grammar, capitalization, and formatting throughout the introduction and setup instructions to improve readability and consistency. Refined step descriptions for better user guidance.

  3. Workflow Approval Configuration Guide: Clarified introductory description of supported workflow types, expanded the workflow list to explicitly include environment promotion, API subscription, and URL customization scenarios, and corrected grammar and terminology in the approval process setup section.

All changes are documentation-only with no modifications to code or functionality. The updates apply to both Developer and Platform Engineer views.

Walkthrough

Three documentation files under the administer section received minor text corrections. The Asgardeo external IdP doc updates the prerequisites lead-in from "be sure" to "make sure" and standardizes "Well-Known URL" capitalization. The Azure AD external IdP doc fixes intro grammar, list item spacing, navigation instruction phrasing, and info callout formatting. The workflow approvals doc expands the introduction to explicitly list three supported workflow types, adds a sentence about environment promotion to production, and corrects grammar and a misspelling of "privileges" in the setup steps note.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the primary change—documentation improvements across multiple guides.
Description check ✅ Passed The description covers the key changes and follows the template structure, though testing sections lack detail.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant