Skip to content

Fix capitalization and wording inconsistencies#389

Open
SashenkaG wants to merge 5 commits into
wso2:mainfrom
SashenkaG:rag-docs
Open

Fix capitalization and wording inconsistencies#389
SashenkaG wants to merge 5 commits into
wso2:mainfrom
SashenkaG:rag-docs

Conversation

@SashenkaG
Copy link
Copy Markdown
Contributor

@SashenkaG SashenkaG commented May 13, 2026

This pull request updates the documentation for RAG (Retrieval-Augmented Generation) features in the WSO2 Integration Platform. The main focus is on improving consistency, clarity, and accuracy in the documentation by standardizing section headings, correcting descriptions, and updating references to managed vector databases. The most important changes are grouped below.

Documentation consistency and clarity

  • Standardized all step headings to sentence case (e.g., "Step 1: initialize the vector store") across ingestion, retrieval, and querying guides for a consistent user experience.
  • Updated main section titles to use title case for consistency (e.g., "RAG Ingestion", "RAG Retrieval", "RAG Service", "Managed Vector Databases").

Improved terminology and accuracy

  • Updated all references from "Managed PostgreSQL and vector databases" to "Managed vector databases" in navigation links, section titles, and descriptions, reflecting the current product naming and scope.
  • Corrected a typo in the RAG service API description ("Clouf" → "Cloud") for accuracy.

Summary by CodeRabbit

  • Documentation
    • Updated RAG ingestion and retrieval documentation with improved structure and clarity.
    • Added new section headers and standardized guided setup step headings for better readability.
    • Refined page titles, descriptions, and navigation link labels across RAG documentation resources to improve consistency and focus.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 13, 2026

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: 6df2d5e7-5da5-473e-90c0-1a9caf836d00

📥 Commits

Reviewing files that changed from the base of the PR and between 868fca1 and 5df4a86.

📒 Files selected for processing (2)
  • en/docs/manage/cloud/rag-ingestion/ingestion.md
  • en/docs/manage/cloud/rag-ingestion/retrieval.md
✅ Files skipped from review due to trivial changes (1)
  • en/docs/manage/cloud/rag-ingestion/ingestion.md

📝 Walkthrough

Walkthrough

This PR updates RAG Retrieval documentation by adding a structural section header ("Set up retrieval") to introduce the guided setup steps and standardizing the "What's next" cross-reference link label to "Managed vector databases" across related pages.

Changes

RAG Retrieval Documentation Updates

Layer / File(s) Summary
Retrieval page setup section and cross-reference update
en/docs/manage/cloud/rag-ingestion/retrieval.md
A new "Set up retrieval" section header is added above the step-by-step retrieval setup instructions, and the "What's next" link label is updated from "Managed PostgreSQL and vector databases" to "Managed vector databases".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • rosensilva
  • KavinduZoysa
  • NipunaRanasinghe
  • anupama-pathirage

Poem

🐰 With section headers clear and cross-links clean,
The retrieval docs now shine and gleam!
Vector databases take their rightful place,
No PostgreSQL clouding up the space.
Clear paths for those who seek to know,
Documentation helps your vectors flow! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers Purpose, Goals, and Approach sections but is missing several required template sections like User stories, Release note, Documentation, and Testing details. Add User stories, Release note, and Documentation sections to align with the repository's description template for complete PR documentation.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title directly reflects the main changes: fixing capitalization (title case for headings) and wording inconsistencies (terminology updates from PostgreSQL references to vector databases).
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

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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
Copy Markdown
Contributor

@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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@en/docs/manage/cloud/rag-ingestion/retrieval.md`:
- Line 18: The document jumps from an H1 to "### Step 1: initialize the vector
store" (the heading string in the diff) which breaks heading hierarchy; add an
H2 above the step headings (for example "## Configure retrieval" or "##
Retrieval steps") so headings increment from H1 -> H2 -> H3, and update any
related section intro text if needed to reference the new H2.

In `@en/docs/manage/cloud/rag-ingestion/vector-databases.md`:
- Line 2: The frontmatter title value "Managed Vector databases" is inconsistent
with the H1 heading "Managed Vector Databases"; update the frontmatter title
string to exactly "Managed Vector Databases" so the frontmatter title and the H1
heading match (edit the frontmatter title key near the top of the file).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 5d401596-2a59-41a7-a3c4-d9fb31c0742d

📥 Commits

Reviewing files that changed from the base of the PR and between 336c37e and 92a55fc.

📒 Files selected for processing (5)
  • en/docs/manage/cloud/rag-ingestion/ingestion.md
  • en/docs/manage/cloud/rag-ingestion/querying.md
  • en/docs/manage/cloud/rag-ingestion/retrieval.md
  • en/docs/manage/cloud/rag-ingestion/service.md
  • en/docs/manage/cloud/rag-ingestion/vector-databases.md

Comment thread en/docs/manage/cloud/rag-ingestion/retrieval.md Outdated
Comment thread en/docs/manage/cloud/rag-ingestion/vector-databases.md Outdated
Comment thread en/docs/manage/cloud/rag-ingestion/ingestion.md Outdated
@LakshanWeerasinghe
Copy link
Copy Markdown
Contributor

@anupama-pathirage can you check this PR?

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.

4 participants