Skip to content

docs: fix typo, deprecated ref, quickstart prerequisites (#1435, #1436, #1438)#1440

Open
clubanderson wants to merge 1 commit intomainfrom
docs/fix-typo-deprecated-quickstart-1435-1438
Open

docs: fix typo, deprecated ref, quickstart prerequisites (#1435, #1436, #1438)#1440
clubanderson wants to merge 1 commit intomainfrom
docs/fix-typo-deprecated-quickstart-1435-1438

Conversation

@clubanderson
Copy link
Copy Markdown
Contributor

Closes #1435
Closes #1436
Closes #1438

Changes

Files Changed

  • docs/mkdocs.yml — sidebar label
  • src/app/docs/page-map.ts — sidebar label
  • docs/content/kubestellar/example-scenarios.md — typo fix
  • docs/content/console/quickstart.md — prerequisites callout

- Mark UI sidebar entry as deprecated in mkdocs.yml and page-map.ts (#1435)
- Fix "Multi-Custer" typo to "Multi-Cluster" in example-scenarios.md (#1436)
- Add prominent callout box clarifying Claude Code dependency in quickstart.md (#1438)

Signed-off-by: Andrew Anderson <andy@clubanderson.com>
@clubanderson clubanderson added the ai-generated PR was generated by AI label Apr 12, 2026
Copilot AI review requested due to automatic review settings April 12, 2026 10:26
@kubestellar-prow kubestellar-prow bot added the dco-signoff: yes Indicates the PR's author has signed the DCO. label Apr 12, 2026
@clubanderson
Copy link
Copy Markdown
Contributor Author

/lgtm

@clubanderson
Copy link
Copy Markdown
Contributor Author

/approve

@netlify
Copy link
Copy Markdown

netlify bot commented Apr 12, 2026

Deploy Preview for kubestellar-docs ready!

Name Link
🔨 Latest commit 844c261
🔍 Latest deploy log https://app.netlify.com/projects/kubestellar-docs/deploys/69db73535c4c1200085a97f4
😎 Deploy Preview https://deploy-preview-1440--kubestellar-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@kubestellar-prow
Copy link
Copy Markdown

@clubanderson: you cannot LGTM your own PR.

Details

In response to this:

/lgtm

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.

@kubestellar-prow kubestellar-prow bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Apr 12, 2026
@github-actions github-actions bot added documentation Improvements or additions to documentation frontend typescript pages yaml labels Apr 12, 2026
@kubestellar-prow
Copy link
Copy Markdown

[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

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

@kubestellar-prow kubestellar-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 12, 2026
@github-actions
Copy link
Copy Markdown
Contributor

❌ PR Title Verification Failed

Your PR title does not follow the required format.

Current title: docs: fix typo, deprecated ref, quickstart prerequisites (#1435, #1436, #1438)

Required Format

PR titles must start with one of these emoji prefixes:

Emoji Meaning
⚠️ Breaking change
Non-breaking feature
🐛 Patch fix / Bug fix
📖 Documentation
🚀 Release
🌱 Infra/Tests/Other

How to Fix

Edit your PR title to start with the appropriate emoji. For example:

  • ✨ Add new feature for user authentication
  • 🐛 Fix crash when loading empty config
  • 📖 Update installation guide

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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment on lines +21 to +34
!!! 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

Copy link

Copilot AI Apr 12, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
!!! 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

Copilot uses AI. Check for mistakes.
> **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.
Copy link

Copilot AI Apr 12, 2026

Choose a reason for hiding this comment

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

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

Suggested change
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.

Copilot uses AI. Check for mistakes.
@github-actions
Copy link
Copy Markdown
Contributor

🔄 Auto-Applying Copilot Code Review

Copilot code review found 2 code suggestion(s) and 0 general comment(s).

@copilot Please apply all of the following code review suggestions:

  • docs/content/console/quickstart.md (line 34): `> Important: Claude Code is required for AI features

This Quick Start us...`

  • docs/content/console/quickstart.md (line 22): This Quick Start supports using **[Claude Code](https://docs.anthropic.com/en/do...

Push all fixes in a single commit. Run npm run build before committing to verify the docs site builds.


Auto-generated by copilot-review-apply workflow.

@github-actions
Copy link
Copy Markdown
Contributor

📖 Preview Links

The following documentation pages were changed in this PR:

Status Page Preview Link
📝 modified quickstart View preview
📝 modified example-scenarios View preview

🔗 Full preview site

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

Labels

ai-generated PR was generated by AI approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates the PR's author has signed the DCO. documentation Improvements or additions to documentation frontend pages size/S Denotes a PR that changes 10-29 lines, ignoring generated files. typescript yaml

Projects

None yet

2 participants