Skip to content

[docs]: Restructure project README - #256

Merged
HiranAdikari merged 4 commits into
wso2:mainfrom
tgcjananga:main
Aug 12, 2026
Merged

[docs]: Restructure project README#256
HiranAdikari merged 4 commits into
wso2:mainfrom
tgcjananga:main

Conversation

@tgcjananga

@tgcjananga tgcjananga commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Purpose

Refresh the Open Cloud DataCenter repository README to provide a clearer introduction to the project, its architecture, and its main components.

Changes

  • Added a new Open Cloud DataCenter README banner.
  • Reorganized the architecture overview.
  • Clarified the two platform interaction paths:
    • Self-service through dcctl, cloud-ui, and the control plane.
    • Infrastructure management through Terraform.
  • Added clearer descriptions of the following branches:
    • terraform
    • operators
    • controlplane
  • Reorganized the CLI and web-console demonstrations.
  • Removed outdated or duplicated README content.

Summary by CodeRabbit

  • Documentation
    • Added a repository banner and status badges.
    • Expanded the architecture overview and documented key branches.
    • Added issue-reporting and contribution guidance.
    • Updated control-plane branch references.
    • Removed outdated repository diagrams, branch tables, and roadmap content.

@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@tgcjananga, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 52 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 0603f5c4-708d-4643-9b21-e76e032ef7c9

📥 Commits

Reviewing files that changed from the base of the PR and between 86ba6e6 and ae5e24a.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

The README was reorganized with repository badges, an architecture overview, branch descriptions, control-plane linking, issue-reporting guidance, and contribution guidance. Older repository-organization content and the roadmap were removed.

Changes

README documentation

Layer / File(s) Summary
Architecture and contribution documentation
README.md
The README adds repository badges, architecture paths, stack branch descriptions, a control-plane link, issue-reporting guidance, and contribution guidance. It removes the former organization diagram, branch table, and roadmap content.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: hiranadikari

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the purpose and changes but omits the required Testing and Checklist sections and uses Purpose instead of Summary. Add Summary, Testing, and Checklist sections, and document validation results and checklist completion.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the README restructuring, which is the main change.
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.
✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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 `@README.md`:
- Around line 18-20: Update the README statement describing the main branch:
either add a link to the externally maintained roadmap or remove “+ roadmap” so
the description accurately reflects the page’s contents.
🪄 Autofix

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 Plus

Run ID: 48f0c66e-0d6d-47ee-b7eb-f5cc8765e869

📥 Commits

Reviewing files that changed from the base of the PR and between 25cb78e and 86ba6e6.

⛔ Files ignored due to path filters (1)
  • docs/media/RepoBanner.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md

Comment thread README.md
@HiranAdikari
HiranAdikari merged commit b83a331 into wso2:main Aug 12, 2026
2 of 3 checks passed
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