docs: fix typo, deprecated ref, quickstart prerequisites (#1435, #1436, #1438)#1440
docs: fix typo, deprecated ref, quickstart prerequisites (#1435, #1436, #1438)#1440clubanderson wants to merge 1 commit intomainfrom
Conversation
|
/lgtm |
|
/approve |
✅ Deploy Preview for kubestellar-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
@clubanderson: you cannot LGTM your own PR. DetailsIn response to this:
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. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: clubanderson The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
❌ PR Title Verification FailedYour PR title does not follow the required format. Current title: Required FormatPR titles must start with one of these emoji prefixes:
How to FixEdit your PR title to start with the appropriate emoji. For example:
You can edit the title by clicking the Edit button next to your PR title. This comment was automatically posted by the PR Title Verifier workflow. |
There was a problem hiding this comment.
Pull request overview
Updates documentation navigation and content to better signal deprecated UI docs, fix a heading typo, and clarify Claude Code prerequisites for the Console Quick Start.
Changes:
- Marked the “UI” docs section as deprecated in both MkDocs and the Next.js docs sidebar.
- Fixed “Multi-Custer” → “Multi-Cluster” in the example scenarios heading.
- Added an upfront prerequisite callout in the Console Quick Start to explain what does/doesn’t require Claude Code.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/app/docs/page-map.ts |
Renames the UI sidebar group to indicate deprecation before navigation. |
docs/mkdocs.yml |
Renames the UI nav label to indicate deprecation in MkDocs navigation. |
docs/content/kubestellar/example-scenarios.md |
Fixes a scenario heading typo that impacts readability/anchors. |
docs/content/console/quickstart.md |
Adds an early prerequisite callout about Claude Code dependency. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| !!! important "Claude Code is required for AI features" | ||
| This Quick Start uses **[Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview)**, Anthropic's CLI tool, to install and manage the kubestellar-mcp plugins that connect the console to your clusters. Claude Code requires an Anthropic API subscription. | ||
|
|
||
| **What requires Claude Code:** | ||
|
|
||
| - Installing kubestellar-mcp plugins via the Claude Code Marketplace (Option A in Step 1) | ||
| - AI Missions (automated issue detection and remediation) | ||
|
|
||
| **What works without Claude Code:** | ||
|
|
||
| - The console dashboard, cards, and multi-cluster views all work without Claude Code | ||
| - You can install kubestellar-mcp plugins via **Homebrew** instead (Option B in Step 1) | ||
| - The `curl` quickstart and source builds do not require Claude Code themselves | ||
|
|
There was a problem hiding this comment.
The docs MDX pipeline here compiles markdown via Nextra/MDX without any pre-processing for MkDocs-style admonitions, so the !!! important directive will render as literal text instead of a callout. Use a supported pattern for callouts (e.g., the existing > **Important**: style used elsewhere in console docs, or an MDX <Callout> component) so this shows up prominently as intended.
| !!! important "Claude Code is required for AI features" | |
| This Quick Start uses **[Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview)**, Anthropic's CLI tool, to install and manage the kubestellar-mcp plugins that connect the console to your clusters. Claude Code requires an Anthropic API subscription. | |
| **What requires Claude Code:** | |
| - Installing kubestellar-mcp plugins via the Claude Code Marketplace (Option A in Step 1) | |
| - AI Missions (automated issue detection and remediation) | |
| **What works without Claude Code:** | |
| - The console dashboard, cards, and multi-cluster views all work without Claude Code | |
| - You can install kubestellar-mcp plugins via **Homebrew** instead (Option B in Step 1) | |
| - The `curl` quickstart and source builds do not require Claude Code themselves | |
| > **Important: Claude Code is required for AI features** | |
| > | |
| > This Quick Start uses **[Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview)**, Anthropic's CLI tool, to install and manage the kubestellar-mcp plugins that connect the console to your clusters. Claude Code requires an Anthropic API subscription. | |
| > | |
| > **What requires Claude Code:** | |
| > | |
| > - Installing kubestellar-mcp plugins via the Claude Code Marketplace (Option A in Step 1) | |
| > - AI Missions (automated issue detection and remediation) | |
| > | |
| > **What works without Claude Code:** | |
| > | |
| > - The console dashboard, cards, and multi-cluster views all work without Claude Code | |
| > - You can install kubestellar-mcp plugins via **Homebrew** instead (Option B in Step 1) | |
| > - The `curl` quickstart and source builds do not require Claude Code themselves |
| > **Try it first!** See a live preview at [kubestellarconsole.netlify.app](https://kubestellarconsole.netlify.app) - no installation needed. | ||
|
|
||
| !!! important "Claude Code is required for AI features" | ||
| This Quick Start uses **[Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview)**, Anthropic's CLI tool, to install and manage the kubestellar-mcp plugins that connect the console to your clusters. Claude Code requires an Anthropic API subscription. |
There was a problem hiding this comment.
This sentence states the Quick Start "uses Claude Code" to install/manage plugins, but a few lines later the callout says the dashboard and plugin installation via Homebrew work without Claude Code. Consider rephrasing the opening line to avoid implying Claude Code is required for the entire Quick Start (and align it with the bullets below).
| This Quick Start uses **[Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview)**, Anthropic's CLI tool, to install and manage the kubestellar-mcp plugins that connect the console to your clusters. Claude Code requires an Anthropic API subscription. | |
| This Quick Start supports using **[Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview)**, Anthropic's CLI tool, to install and manage the kubestellar-mcp plugins via the Claude Code Marketplace and to enable AI features. Claude Code requires an Anthropic API subscription. |
🔄 Auto-Applying Copilot Code ReviewCopilot code review found 2 code suggestion(s) and 0 general comment(s). @copilot Please apply all of the following code review suggestions:
Push all fixes in a single commit. Run Auto-generated by copilot-review-apply workflow. |
📖 Preview LinksThe following documentation pages were changed in this PR:
|
Closes #1435
Closes #1436
Closes #1438
Changes
mkdocs.ymlandpage-map.tsso users see the deprecation before clickingexample-scenarios.md!!! importantcallout box at the top ofconsole/quickstart.mdexplaining what requires Claude Code vs. what works without itFiles Changed
docs/mkdocs.yml— sidebar labelsrc/app/docs/page-map.ts— sidebar labeldocs/content/kubestellar/example-scenarios.md— typo fixdocs/content/console/quickstart.md— prerequisites callout