Skip to content

fix(docs): correct typos in documentation#1452

Open
nil957 wants to merge 1 commit intokubestellar:mainfrom
nil957:fix/typos-issues-1436-1429
Open

fix(docs): correct typos in documentation#1452
nil957 wants to merge 1 commit intokubestellar:mainfrom
nil957:fix/typos-issues-1436-1429

Conversation

@nil957
Copy link
Copy Markdown

@nil957 nil957 commented Apr 12, 2026

Summary

This PR fixes two typos in the documentation:

  1. Issue Scenario 3 Title Has Typo : "Multi-Custer" Instead of "Multi-Cluster" #1436: Fixed 'Multi-Custer' → 'Multi-Cluster' in the Scenario 3 heading of docs/content/kubestellar/example-scenarios.md (line 247)

    • This typo affects the section heading anchor which could impact linking

  2. Issue Font Name Typo in mkdocs.yml (SapceMono instead of SpaceMono) #1429: Fixed 'SapceMono' → 'Space Mono' in docs/mkdocs.yml (line 149)

    • This caused MkDocs-rendered documentation to fall back to a default system font instead of the intended Space Mono font

Changes Made

  • docs/content/kubestellar/example-scenarios.md: Corrected section heading typo
  • docs/mkdocs.yml: Corrected font name configuration

Testing

  • Verified the changes are purely textual corrections
  • No functional changes to the documentation

Fixes #1436
Fixes #1429

fix(docs): correct typos in documentation
2682792 
- Fix 'Multi-Custer' → 'Multi-Cluster' in example-scenarios.md (fixes kubestellar#1436)
- Fix 'SapceMono' → 'Space Mono' in mkdocs.yml (fixes kubestellar#1429)

Signed-off-by: vibeyclaw <vibeyclaw@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 12, 2026 13:33
@kubestellar-prow
Copy link
Copy Markdown

kubestellar-prow bot commented Apr 12, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign clubanderson 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

@kubestellar-prow kubestellar-prow bot added the dco-signoff: yes Indicates the PR's author has signed the DCO. label Apr 12, 2026
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 12, 2026 •
edited
Loading

✅ Deploy Preview for kubestellar-docs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 2682792
🔍 Latest deploy log https://app.netlify.com/projects/kubestellar-docs/deploys/69db9f1d5f07f00009f2b835
😎 Deploy Preview https://deploy-preview-1452--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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 12, 2026

👋 Welcome to the KubeStellar community! 💖

Thanks and congrats 🎉 for opening your first PR here! We're excited to have you contributing.

Before merge, please ensure:

  • ✅ DCO Sign-off — All commits signed with git commit -s (DCO)
  • ✅ PR Title — Starts with an emoji: ✨ feature | 🐛 bug fix | 📖 docs | 🌱 infra/tests | ⚠️ breaking

📬 If you're using KubeStellar in your organization, please add your name to our Adopters list. 🙏 It really helps the project gain momentum and credibility — a small contribution back with a big impact.

Resources:

A maintainer will review your PR soon. Hope you have a great time here!

🌟 ~~~~~~~~~~ 🌟

📬 If you like KubeStellar, please ⭐ star ⭐ our repo to support it!

🙏 It really helps the project gain momentum and credibility — a small contribution back with a big impact.

@github-actions github-actions bot added documentation Improvements or additions to documentation yaml labels Apr 12, 2026
@kubestellar-prow
Copy link
Copy Markdown

kubestellar-prow bot commented Apr 12, 2026

Hi @nil957. Thanks for your PR.

I'm waiting for a kubestellar 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.

@kubestellar-prow kubestellar-prow bot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 12, 2026
Copilot AI reviewed Apr 12, 2026
View reviewed changes
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

Note

Copilot was unable to run its full agentic suite in this review.

Fixes two documentation typos that affected (1) a scenario heading/anchor and (2) MkDocs font configuration so the intended font renders.

Changes:

  • Corrected “Multi-Custer” → “Multi-Cluster” in Scenario 3 heading (affects generated anchor).
  • Corrected MkDocs theme font value “SapceMono” → “Space Mono”.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/mkdocs.yml Fixes the configured text font name so MkDocs Material uses the intended font.
docs/content/kubestellar/example-scenarios.md Fixes a scenario heading typo, updating the visible title and generated anchor.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docs/content/kubestellar/example-scenarios.md
@@ -244,7 +244,7 @@ clusters=("$wds_context" "$wec1_context" "$wec2_context");
done
```

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.

Changing the heading text will change the auto-generated anchor/slug. If any existing internal/external links relied on the previous (misspelled) anchor, they’ll now break. Consider adding a backward-compatible alias anchor (e.g., an explicit id for the heading plus a separate hidden anchor for the old slug) so both old and new links keep working.

Suggested change
<a id="scenario-3-multicluster-workload-deployment-with-helm"></a>

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

dco-signoff: yes Indicates the PR's author has signed the DCO. documentation Improvements or additions to documentation needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. yaml

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Scenario 3 Title Has Typo : "Multi-Custer" Instead of "Multi-Cluster" Font Name Typo in mkdocs.yml (SapceMono instead of SpaceMono)

2 participants

@nil957