Skip to content

Improve clarity and consistency in introduction.md#500

Open
Yathunanthanasarma wants to merge 1 commit into
wso2:mainfrom
Yathunanthanasarma:patch-1
Open

Improve clarity and consistency in introduction.md#500
Yathunanthanasarma wants to merge 1 commit into
wso2:mainfrom
Yathunanthanasarma:patch-1

Conversation

@Yathunanthanasarma

@Yathunanthanasarma Yathunanthanasarma commented May 22, 2026

Copy link
Copy Markdown

Refined wording for clarity and consistency throughout the introduction section, ensuring proper punctuation and structure.

Purpose

Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter �N/A� plus brief explanation of why there�s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type �Sent� when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type �N/A� and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Summary by CodeRabbit

  • Documentation
    • Updated introductory documentation with improved wording, enhanced formatting, and more consistent language conventions for increased clarity.

Review Change Stack

Refined wording for clarity and consistency throughout the introduction section, ensuring proper punctuation and structure.
@CLAassistant

CLAassistant commented May 22, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@coderabbitai

coderabbitai Bot commented May 22, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7e12ecde-ee10-4af0-b3d0-72bbf0eb1bd0

📥 Commits

Reviewing files that changed from the base of the PR and between d7b6504 and d3c2549.

📒 Files selected for processing (1)
  • en/docs/get-started/introduction.md

📝 Walkthrough

Walkthrough

Single-file documentation update to introduction.md with copy refinements: removed "100%" from the platform premise, adjusted punctuation on self-hosted description, replaced "doesn't" with "does not", and rewrote the low-code/pro-code parity statement for consistency. All changes are minor wording and formatting improvements without altering content structure or meaning.

Changes

Introduction Page Copy Edits

Layer / File(s) Summary
Copy and punctuation updates
en/docs/get-started/introduction.md
Opening premise reworded to remove quantitative claim; self-hosted section punctuation adjusted with colon before infrastructure list; control plane description uses formal "does not" instead of contraction; low-code/pro-code parity section rephrased with "remain in sync" for clarity.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • rosensilva
  • anupama-pathirage
  • KavinduZoysa
  • NipunaRanasinghe

Poem

🐰 A polish here, a phrase refined,
"100%" dropped, new wording signed,
Self-hosted shines with colon grace,
Low-code stays in sync—all in place! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description includes the template structure but all sections contain only placeholder text with no actual content filled in, making it largely incomplete despite following the required format. Fill in the required sections with specific information: Purpose/Goals (explain what clarity issues were addressed), Approach (describe the specific wording changes made), and mark non-applicable sections (Security checks, Automation tests, etc.) as N/A with explanations.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: wording and clarity improvements in introduction.md, which aligns with the file modifications described in the raw summary.
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.

2 participants