Skip to content

Documentation Overhaul#360

Merged
cjimti merged 1 commit intomasterfrom
docs/overhaul
Jan 5, 2026
Merged

Documentation Overhaul#360
cjimti merged 1 commit intomasterfrom
docs/overhaul

Conversation

@cjimti
Copy link
Copy Markdown
Member

@cjimti cjimti commented Jan 5, 2026

Comprehensive documentation overhaul for kubefwd.com:

User Guide Rename & Enhancement

  • Renamed tui-guide.md to user-guide.md for broader scope
  • Replaced all ASCII art mockups with actual TUI screenshots
  • Added comprehensive keyboard shortcuts and workflow documentation

Getting Started Overhaul

  • Highlighted Idle Mode as the recommended approach for MCP/AI workflows
  • Added Scoop as the Windows installation method
  • Implemented tabbed installation instructions (macOS/Windows/Linux/Docker)
  • Added Operating Modes section explaining Idle vs Classic modes

MCP Integration Rewrite

  • Fixed misleading platform support table (ChatGPT requires tunnel, not native stdio)
  • Added support for JetBrains IDEs, Gemini CLI, VS Code Copilot
  • Replaced ASCII architecture diagram with Mermaid flowchart
  • Added ChatGPT tunnel setup instructions

Site Cleanup

  • Removed blog section (content covered in main docs and personal blog)
  • Updated all cross-references across documentation files

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • Test improvement (new or updated tests)
  • Documentation update
  • Stability/performance improvement
  • Build/CI improvement

Note: New features are developed by maintainers only. See CONTRIBUTING.md for details.

Related Issues

N/A - Documentation improvement initiative

Testing

  • Ran go test ./... locally
  • Tested manually with a Kubernetes cluster
  • Added new tests for changes (if applicable)
  • Ran mkdocs build successfully
  • Verified all internal links resolve correctly

Checklist

  • My code follows the project's style guidelines (go fmt, go vet)
  • I have read CONTRIBUTING.md
  • I have updated documentation if needed
  • This PR is focused and does not include unrelated changes

Screenshots/Logs (if applicable)

Documentation changes use existing TUI screenshots from docs/images/:

  • 100_TUI_idle-mode.png - Idle Mode view
  • 110_TUI_help.png - Help overlay
  • 120_TUI_browse-namespaces.png - Namespace browser
  • 130_TUI_browse-services.png - Service browser
  • 140_TUI_forwards.png - Active forwards list
  • 150_TUI_forward_details_*.png - Forward detail views
  • 160_TUI_forward_details_http.png - HTTP traffic view

Files Changed

  • docs/user-guide.md (new, replaces tui-guide.md)
  • docs/getting-started.md (major rewrite)
  • docs/mcp-integration.md (major rewrite)
  • docs/index.md (updated)
  • docs/comparison.md (updated references)
  • docs/overrides/404.html (updated references)
  • mkdocs.yml (navigation update, removed blog plugin)
  • README.md (updated references)
  • docs/blog/ (removed)

- Removed `docs/tui-guide.md` and introduced the new `docs/user-guide.md`.
- Updated `mkdocs.yml` navigation to reflect the new structure.
- Enhanced the User Guide with improved workflows, visuals, and comprehensive usage instructions for kubefwd's TUI.
- Updated `/docs/index.md` to align with the renaming and revised content structure.
@cjimti cjimti self-assigned this Jan 5, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 63.91%. Comparing base (24ef0c4) to head (7154311).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #360   +/-   ##
=======================================
  Coverage   63.91%   63.91%           
=======================================
  Files          70       70           
  Lines       12461    12461           
=======================================
  Hits         7965     7965           
  Misses       4166     4166           
  Partials      330      330           

see 2 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cjimti cjimti merged commit 080853c into master Jan 5, 2026
12 checks passed
@cjimti cjimti deleted the docs/overhaul branch January 6, 2026 21:40
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.

1 participant