Skip to content

docs: professionalize docs — document web UI/operator/day-2 ops, fix site-wide table rendering#5238

Merged
devantler merged 3 commits into
mainfrom
claude/naughty-beaver-71e920
Jun 11, 2026
Merged

docs: professionalize docs — document web UI/operator/day-2 ops, fix site-wide table rendering#5238
devantler merged 3 commits into
mainfrom
claude/naughty-beaver-71e920

Conversation

@devantler

Copy link
Copy Markdown
Contributor

🤖 Generated by the Daily AI Assistant

Summary

A documentation professionalization pass: closes the biggest content gaps, fixes stale claims, upgrades presentation — and fixes a site-wide rendering regression found along the way.

🐛 Site-wide fix: GFM tables broken in production

Every markdown table on the published site currently renders as literal pipe text (see the live support matrix). On Astro 6.4.x the implicit GFM default is dropped when integrations use the deprecated markdown.remarkPlugins hook. Pinning markdown: { gfm: true } in astro.config.mjs restores tables everywhere (verified: support-matrix goes from 0 to 8 <table> elements).

📄 New pages (previously undocumented features)

  • Web UI & Desktop Appksail ui, ksail desktop, and the in-cluster UI; one UI, three surfaces, with a mermaid overview and read-only/OIDC guidance
  • Kubernetes Operator — Helm chart install, Cluster CRD usage, web UI enablement, OIDC, uninstall caveats
  • Day-2 Operationscluster diagnose (health scoring, JSON output, AI integration), cluster switch (picker, history, filtering), cluster repair

✍️ Stub pages expanded with real content

  • Backup & Restore — scoping flags, restore policies, dependency ordering, migration walkthrough
  • CI/CD Integration — composite action inputs/outputs, GitOps + security-scanning recipes, cleanup guidance
  • Registry Management — local vs mirror registries contrasted, [user:pass@]host[=upstream] syntax explained, declarative config
  • Workload Management — full command map grouped by task (deploy / inspect / operate / validate / images / GitOps)

🧭 Freshness & presentation

  • Concepts now lists all six distributions (EKS added) and the AWS provider
  • Homepage: EKS claim qualified, new tiles for diagnostics / web UI / operator, AI plugins card added
  • Features overview reorganized into journey-grouped LinkCards (Run Clusters / Ship Workloads / Scale Out)
  • Theme-matched LinkCard + <kbd> styling, reduced-motion guards; sidebar gains the new pages

Validation

  • npm run build succeeds (176 pages); all changed pages verified to contain rendered <table> elements
  • Visually verified via local preview: dark + light themes, desktop + mobile viewports, mermaid render, sidebar badges
  • All internal links checked against existing slugs (generated cli-flags/ pages untouched)

🤖 Generated with Claude Code

devantler and others added 2 commits June 11, 2026 20:32
On Astro 6.4.x the implicit GFM default (tables, strikethrough,
autolinks) is dropped when integrations pass the deprecated
markdown.remarkPlugins hook, so every table on the published site
currently renders as literal pipe text (verify on
https://ksail.devantler.tech/support-matrix/). Pin markdown.gfm: true
so table rendering cannot silently regress again.

Also adds the new feature pages to the sidebar.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…ture pages

New pages for previously undocumented surfaces:
- Web UI & Desktop App (ksail ui / ksail desktop / in-cluster UI)
- Kubernetes Operator (Helm chart, Cluster CRD, OIDC, read-only mode)
- Day-2 Operations (diagnose health scoring, switch picker, repair)

Expanded the stub feature pages with real content: backup/restore
(scoping flags, restore policies, migration walkthrough), CI/CD
(composite action inputs/outputs, GitOps and scanning recipes),
registry management (local vs mirror registries, syntax explained),
and workload management (full command map grouped by task).

Freshness fixes: concepts now lists all six distributions plus the
AWS provider; the homepage no longer overstates EKS support and gains
tiles for diagnostics, the web UI, and the operator.

Presentation: the features overview is reorganized into journey-grouped
LinkCards (run clusters / ship workloads / scale out); custom.css gains
theme-matched LinkCard and kbd styling with reduced-motion guards.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

MegaLinter analysis: Success

✅ Linters with no issues

actionlint, bash-exec, git_diff, hadolint, jscpd, jsonlint, lychee, markdown-table-formatter, markdownlint, prettier, prettier, shellcheck, shfmt, stylelint, syft, trivy-sbom, trufflehog, v8r, v8r, yamllint

Notices

📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)

See detailed reports in MegaLinter artifacts

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

@devantler devantler marked this pull request as ready for review June 11, 2026 19:05
@devantler devantler enabled auto-merge (squash) June 11, 2026 19:06
Target the LinkCard title span directly instead of the descendant
anchor, so the selector's key element no longer conflicts with the
higher-specificity markdown link rule above it. Same computed style
(verified in preview).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@devantler devantler merged commit 993e653 into main Jun 11, 2026
42 checks passed
@devantler devantler deleted the claude/naughty-beaver-71e920 branch June 11, 2026 19:42
@github-project-automation github-project-automation Bot moved this from 🫴 Ready to ✅ Done in 🌊 Project Board Jun 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

1 participant