Skip to content

Commit 080853c

Browse files
authored
Replace outdated TUI guide with revamped User Guide (#360)
- 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.
1 parent 24ef0c4 commit 080853c

20 files changed

+922
-387
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/11659/badge)](https://www.bestpractices.dev/projects/11659)
1212
[![SLSA 3](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev)
1313

14-
**[Documentation](https://kubefwd.com)** | **[Getting Started](https://kubefwd.com/getting-started/)** | **[TUI Guide](https://kubefwd.com/tui-guide/)** | **[API Reference](https://kubefwd.com/api-reference/)** | **[MCP (AI Integration)](https://kubefwd.com/mcp-integration/)**
14+
**[Documentation](https://kubefwd.com)** | **[Getting Started](https://kubefwd.com/getting-started/)** | **[User Guide](https://kubefwd.com/user-guide/)** | **[API Reference](https://kubefwd.com/api-reference/)** | **[MCP (AI Integration)](https://kubefwd.com/mcp-integration/)**
1515

1616
## Develop Locally, Connect to Kubernetes
1717

@@ -116,7 +116,7 @@ See [Comparison](https://kubefwd.com/comparison/) for detailed comparisons with
116116
Full documentation at **[kubefwd.com](https://kubefwd.com)**:
117117

118118
- [Getting Started](https://kubefwd.com/getting-started/) - Installation and setup
119-
- [TUI Guide](https://kubefwd.com/tui-guide/) - Interface and shortcuts
119+
- [User Guide](https://kubefwd.com/user-guide/) - Interface and shortcuts
120120
- [Configuration](https://kubefwd.com/configuration/) - CLI options
121121
- [Advanced Usage](https://kubefwd.com/advanced-usage/) - Multi-cluster, selectors
122122
- [REST API](https://kubefwd.com/api-reference/) - API reference

docs/comparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,4 +249,4 @@ For developers who primarily need to connect their local code to cluster depende
249249

250250
---
251251

252-
*See also: [Getting Started](getting-started.md) | [TUI Guide](tui-guide.md) | [Architecture](architecture.md)*
252+
*See also: [Getting Started](getting-started.md) | [User Guide](user-guide.md) | [Architecture](architecture.md)*

0 commit comments

Comments
 (0)