Skip to content

Move CLI command reference under Reference section#964

Open
jhivandb wants to merge 2 commits into
wso2:mainfrom
jhivandb:cli-docs-refactor-agent-manager
Open

Move CLI command reference under Reference section#964
jhivandb wants to merge 2 commits into
wso2:mainfrom
jhivandb:cli-docs-refactor-agent-manager

Conversation

@jhivandb
Copy link
Copy Markdown
Contributor

@jhivandb jhivandb commented May 26, 2026

Purpose

Nests the amctl CLI command reference under the Reference sidebar category alongside the MCP server reference, so all reference material lives in one place.

Goals

Reorganize the docs sidebar so amctl command reference pages sit under Reference → CLI rather than as a top-level category.

Approach

  • Moved documentation/docs/cli/*.mdxdocumentation/docs/reference/cli/*.mdx
  • Updated documentation/sidebars.ts to render CLI as a collapsible subcategory under Reference (removed top-level CLI category)
  • Updated cross-references in documentation/docs/getting-started/cli-installation.mdx to point at the new paths
  • Fixed a now-broken relative link in reference/cli/agent.mdx (../tutorials/...../../tutorials/...) that the file move would otherwise leave dangling

Verified locally with make -C documentation build → success.

User stories

N/A — sidebar reorganization, no user-facing functional change.

Release note

Documentation: amctl CLI command reference is now under the Reference section in the docs sidebar.

Documentation

This PR is the documentation change.

Training

N/A — no training content impact.

Certification

N/A — no impact on certification exams.

Marketing

N/A — internal docs reorganization.

Automation tests

  • Unit tests

    N/A — docs-only change.

  • Integration tests

    N/A — docs-only change. Verified make -C documentation build passes.

Security checks

Samples

N/A

Related PRs

N/A

Migrations (if applicable)

N/A — no schema or runtime change.

Test environment

Docusaurus 3.9.2 build on macOS (Node v20.15.1).

Learning

N/A — straightforward docs restructure.

Summary by CodeRabbit

  • Documentation
    • Reorganized CLI documentation under a dedicated reference section for improved navigation and discoverability.
    • Updated documentation links to reflect the new structure.

Review Change Stack

claude and others added 2 commits May 26, 2026 10:52
Nest the amctl CLI command reference docs under the Reference category
alongside the MCP server reference, matching the structural convention.
Files moved from docs/cli/ to docs/reference/cli/; sidebar updated to
present CLI as a collapsible category under Reference; getting-started
cross-references updated to the new paths.
@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ jhivandb
❌ claude
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 26, 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: f5e41819-018d-46e3-a60a-a9ccb8868867

📥 Commits

Reviewing files that changed from the base of the PR and between f695a9f and 5df5f0f.

📒 Files selected for processing (9)
  • documentation/docs/getting-started/cli-installation.mdx
  • documentation/docs/reference/cli/agent.mdx
  • documentation/docs/reference/cli/context.mdx
  • documentation/docs/reference/cli/login.mdx
  • documentation/docs/reference/cli/overview.mdx
  • documentation/docs/reference/cli/project.mdx
  • documentation/docs/reference/cli/skills.mdx
  • documentation/docs/reference/cli/version.mdx
  • documentation/sidebars.ts

📝 Walkthrough

Walkthrough

CLI documentation is reorganized from a top-level category to the Reference section. The sidebar navigation structure is updated, and internal documentation links in getting-started and reference pages are adjusted to match the new file paths.

Changes

Documentation CLI Reorganization

Layer / File(s) Summary
Sidebar navigation restructuring
documentation/sidebars.ts
CLI category removed from top-level and added under Reference section with collapsed: true, updating item paths from cli/* to reference/cli/*.
Internal documentation link updates
documentation/docs/getting-started/cli-installation.mdx, documentation/docs/reference/cli/agent.mdx
Next Steps links updated to ../reference/cli/... paths and See Also link adjusted to ../../tutorials/... to reflect the reorganized documentation structure.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 The CLI docs hop to Reference's nest,
Sidebar paths aligned with the best,
Links now point true to their new home,
Through organized halls where the references roam! 📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: moving CLI command reference documentation to the Reference section of the sidebar.
Description check ✅ Passed The description covers all required template sections with appropriate detail for a documentation-only change, including purpose, goals, approach, and clear explanations of why N/A applies to non-applicable sections.
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.

@jhivandb jhivandb requested a review from AnoshanJ May 26, 2026 05:29
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.

5 participants