Skip to content

[docs-agent] Update CLI documentation — add cluster/OIDC/login commands, convert ASCII to Mermaid#83

Open
redhat-chai-bot wants to merge 1 commit into
openshift-online:mainfrom
redhat-chai-bot:docs-agent/comprehensive-doc-update-20260623
Open

[docs-agent] Update CLI documentation — add cluster/OIDC/login commands, convert ASCII to Mermaid#83
redhat-chai-bot wants to merge 1 commit into
openshift-online:mainfrom
redhat-chai-bot:docs-agent/comprehensive-doc-update-20260623

Conversation

@redhat-chai-bot

Copy link
Copy Markdown

Automated Documentation Update

Changes Made

12 files changed — CLAUDE.md, README.md, ARCHITECTURE.md, DEVELOPMENT.md, and 8 files with Prettier formatting fixes.

Triggered By

Recent PRs (last 7 days):

Overall Documentation Validation:

  • CLAUDE.md: Added 3 missing command groups (cluster, clusteroidc, login) to the commands listing. Added internal/config/ to Key Directories.
  • README.md: Documented all 3 undocumented command groups — cluster management (create, list, kubeconfig, get-token), cluster-oidc (create, delete, list), and login. Updated Project Structure tree to include cluster/, clusteroidc/, login/, internal/config/, internal/services/cluster/, internal/services/clusteroidc/. Converted Architecture section ASCII diagram to Mermaid.
  • ARCHITECTURE.md: Converted 2 large ASCII diagrams (Direct CloudFormation flow, Lambda mode flow) to Mermaid. Added cluster, clusteroidc, and login to CLI Layer section. Added cluster and clusteroidc services plus config layer to Service Layer section.
  • DEVELOPMENT.md: Updated Project Structure tree with new directories.
  • Prettier: Fixed formatting across all 12 markdown files.

Undocumented areas noted (for human review):

  • README Features section could be expanded to highlight cluster lifecycle and OIDC management as primary features
  • docs/guides/DEVELOPMENT.md ASCII art for workflow diagrams could be converted to Mermaid in a follow-up

Supersedes PR #80 (which covered a subset of these changes).

/cc @slopezz @jmelis — please review these updates.


Generated by Chai Bot documentation update task (weekly validation).

…ds, convert ASCII to Mermaid

- CLAUDE.md: Add missing commands (cluster, clusteroidc, login) to
  Key Directories table, add internal/config/ entry
- README.md: Document cluster management commands (create, list,
  kubeconfig, get-token), cluster-oidc commands (create, delete,
  list), and login command; update Basic Usage with new commands;
  update Project Structure tree with new directories; convert
  ASCII architecture diagram to Mermaid with all command groups
- docs/architecture/ARCHITECTURE.md: Convert 2 ASCII diagrams
  (Direct CloudFormation, Lambda flow) to Mermaid; add cluster,
  cluster-oidc, and login to CLI Layer section; add cluster and
  clusteroidc services and config layer to Service Layer section
- docs/guides/DEVELOPMENT.md: Update Project Structure tree with
  new command and service directories
- Fix prettier formatting across all 12 markdown files

Supersedes openshift-online#80.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@redhat-chai-bot, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 59 minutes and 59 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

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 credits.

🚦 How do rate limits work?

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

For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository: openshift-online/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: f0b68e13-16fc-4481-bdd7-6cea9b324158

📥 Commits

Reviewing files that changed from the base of the PR and between 94e5fc1 and abcccad.

📒 Files selected for processing (12)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/feature_request.md
  • CLAUDE.md
  • README.md
  • docs/README.md
  • docs/architecture/ARCHITECTURE.md
  • docs/guides/DEVELOPMENT.md
  • docs/guides/DOCUMENTATION.md
  • docs/guides/VERSIONING.md
  • docs/specs/reference-gist-1.md
  • docs/specs/references.md
  • test/localstack/README.md
✨ 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.

@openshift-ci

openshift-ci Bot commented Jun 23, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: redhat-chai-bot
Once this PR has been reviewed and has the lgtm label, please assign jmelis for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci Bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 23, 2026
@openshift-ci

openshift-ci Bot commented Jun 23, 2026

Copy link
Copy Markdown

Hi @redhat-chai-bot. Thanks for your PR.

I'm waiting for a openshift-online member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@redhat-chai-bot

Copy link
Copy Markdown
Author

Auto-closing: this documentation update was not reviewed within 3 days. If the changes are still relevant, a new PR will be opened in a future run.

1 similar comment
@redhat-chai-bot

Copy link
Copy Markdown
Author

Auto-closing: this documentation update was not reviewed within 3 days. If the changes are still relevant, a new PR will be opened in a future run.

@redhat-chai-bot

Copy link
Copy Markdown
Author

Auto-closing: this documentation update was not reviewed within 3 days and has been superseded by newer work. No CLI documentation changes were needed this cycle.

@redhat-chai-bot

Copy link
Copy Markdown
Author

Auto-closing: this documentation update was not reviewed within 3 days. If the changes are still relevant, a new PR will be opened in a future run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant