Skip to content

fix: correct branding references, typos, and formatting issues across documentation#169

Open
HesandaLiyanage wants to merge 1 commit intowso2:mainfrom
HesandaLiyanage:fix/documentation-typos-and-branding-corrections
Open

fix: correct branding references, typos, and formatting issues across documentation#169
HesandaLiyanage wants to merge 1 commit intowso2:mainfrom
HesandaLiyanage:fix/documentation-typos-and-branding-corrections

Conversation

@HesandaLiyanage
Copy link

@HesandaLiyanage HesandaLiyanage commented Mar 4, 2026

Purpose

Fix several documentation quality issues including leftover "Choreo" branding references, typos, grammar errors, and MkDocs admonition formatting problems found across multiple documentation pages.

Goals

Improve documentation accuracy and consistency by:

  • Replacing all leftover "Choreo" references with "Devant"
  • Fixing typos and grammatical errors
  • Correcting MkDocs admonition syntax for proper rendering

Approach

Manual review of documentation files to identify and fix the following issues:

Branding Issues

data-planes.md
: Replaced leftover "Choreo" in image alt text with "Devant"
data-planes.md
: Fixed incorrect casing "Wso2" → "WSO2"
Typos

deployment-tracks.md
: Fixed "Hover" → "However"
Grammar Fixes

data-planes.md
: Fixed subject-verb agreement — "all traffic related to the runtime of user integrations are restricted" → "is restricted"
data-planes.md
: Fixed noun-pronoun agreement — "data planes itself" → "data plane itself"
organization.md
: Fixed missing article — "as member of" → "as a member of"
MkDocs Formatting

manage-configurations-and-secrets.md
: Added missing space after !!! in two admonition blocks (!!!info → !!! info)
devant-managed-databases-and-caches.md
: Fixed admonition casing and spacing (!!!Tip → !!! tip)
Other

devant-managed-caches.md
: Removed stray escaped asterisk * before "redis-cli"

User stories

N/A — Documentation quality fix

Release note

N/A — No functional changes

Documentation

This PR is the documentation fix.

Training

N/A

Certification

N/A

Marketing

N/A

Automation tests

  • Unit tests

    N/A

  • Integration tests

    N/A

Security checks

Samples

N/A

Related PRs

N/A

Migrations (if applicable)

N/A

Test environment

N/A

Learning

N/A

Summary by CodeRabbit

  • Documentation
    • Fixed grammar and spelling errors throughout documentation.
    • Improved clarity in API versioning and organization descriptions.
    • Corrected markdown formatting in admonitions and notes.
    • Updated image captions for accuracy.

@CLAassistant
Copy link

CLAassistant commented Mar 4, 2026

CLA assistant check
All committers have signed the CLA.

@coderabbitai
Copy link

coderabbitai bot commented Mar 4, 2026

Walkthrough

Documentation updates across multiple Devant guides addressing grammar corrections, capitalization fixes, markdown syntax standardization, and text clarifications. No code or functional changes were introduced.

Changes

Cohort / File(s) Summary
Devant Concepts Documentation
en/docs/devant-concepts/data-planes.md, en/docs/devant-concepts/deployment-tracks.md, en/docs/devant-concepts/organization.md
Grammar and text corrections including capitalization of "WSO2 Micro Integrator," subject-verb agreement fixes ("are restricted" → "is restricted"), plurality correction ("data planes itself" → "data plane itself"), article additions ("a member"), and conjunction clarification ("Hover" → "However").
DevOps and Caching Documentation
en/docs/devops-and-ci-cd/manage-configurations-and-secrets.md, en/docs/manage-databases-and-caches/devant-managed-caches.md, en/docs/manage-databases-and-caches/devant-managed-databases-and-caches.md
Markdown syntax standardization (!!!info → !!! info, !!!Tip → !!! tip) and removal of unnecessary asterisk emphasis from redis-cli reference. Formatting updates with no content behavior changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Poem

🐰 Through docs we hopped with careful eye,
Grammar fixed and syntax bright,
Capitals gleamed, mistakes we'd spy,
Now Devant reads just right!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main changes: correcting branding references, typos, and formatting issues across documentation files.
Description check ✅ Passed The description follows the template structure with clear Purpose, Goals, and Approach sections that comprehensively document the documentation quality fixes being made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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.

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.

🧹 Nitpick comments (2)
en/docs/manage-databases-and-caches/devant-managed-caches.md (1)

88-88: Optional: tighten command naming for clarity.

Line 88 is improved, but you may want to phrase it as “use the redis-cli and INFO command” for consistency with command-style formatting.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/docs/manage-databases-and-caches/devant-managed-caches.md` at line 88,
Update the wording to use consistent command-style capitalization: change the
phrase "use the redis-cli and info command" to "use the redis-cli and INFO
command" so it references the redis-cli tool and the INFO command explicitly;
locate the sentence containing "redis-cli and info command" and replace "info"
with uppercase "INFO" for clarity and consistency.
en/docs/devant-concepts/data-planes.md (1)

10-10: Optional: simplify sentence structure for readability.

Line 10 is correct on branding/casing, but the clause around build options is still a bit hard to parse. Consider splitting into two short sentences.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/docs/devant-concepts/data-planes.md` at line 10, Split the long sentence
that begins "The integrations can be built in [Ballerina]..." into two shorter
sentences to improve readability: first state that integrations can be built
using Ballerina, WSO2 Micro Integrator, or the Devant Cloud Editor; then follow
with a second sentence noting that these options are optimized for building
integrations. Keep the final sentence about traffic restriction as-is to
preserve branding/casing and meaning.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@en/docs/devant-concepts/data-planes.md`:
- Line 10: Split the long sentence that begins "The integrations can be built in
[Ballerina]..." into two shorter sentences to improve readability: first state
that integrations can be built using Ballerina, WSO2 Micro Integrator, or the
Devant Cloud Editor; then follow with a second sentence noting that these
options are optimized for building integrations. Keep the final sentence about
traffic restriction as-is to preserve branding/casing and meaning.

In `@en/docs/manage-databases-and-caches/devant-managed-caches.md`:
- Line 88: Update the wording to use consistent command-style capitalization:
change the phrase "use the redis-cli and info command" to "use the redis-cli and
INFO command" so it references the redis-cli tool and the INFO command
explicitly; locate the sentence containing "redis-cli and info command" and
replace "info" with uppercase "INFO" for clarity and consistency.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: db211503-4e93-4507-9435-badaf5d665fd

📥 Commits

Reviewing files that changed from the base of the PR and between 7633ced and 36f8ac3.

📒 Files selected for processing (6)
  • en/docs/devant-concepts/data-planes.md
  • en/docs/devant-concepts/deployment-tracks.md
  • en/docs/devant-concepts/organization.md
  • en/docs/devops-and-ci-cd/manage-configurations-and-secrets.md
  • en/docs/manage-databases-and-caches/devant-managed-caches.md
  • en/docs/manage-databases-and-caches/devant-managed-databases-and-caches.md

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