From 20442071b7bf69cdfc792a8c446c2c7d9c17c548 Mon Sep 17 00:00:00 2001 From: benbenbang Date: Sat, 6 Sep 2025 15:01:11 +0200 Subject: [PATCH] docs(mkdocs): clean content and add short demo --- docs/docs/features/overview.md | 40 +++++++++++++++++----------------- docs/docs/index.md | 26 +++++++++++++++------- 2 files changed, 38 insertions(+), 28 deletions(-) diff --git a/docs/docs/features/overview.md b/docs/docs/features/overview.md index 1f7e6e9..a92b792 100644 --- a/docs/docs/features/overview.md +++ b/docs/docs/features/overview.md @@ -4,15 +4,15 @@ Tombo brings powerful Python package management capabilities directly to VS Code ## Core Features -### 🎯 Rich Hover Information +### Rich Hover Information Get comprehensive package details without leaving your editor: -- **📦 Package description** - What the package does -- **🏷️ Latest version** - Current stable release -- **🐍 Python compatibility** - Supported Python versions -- **📅 Version history** - Recent releases with dates -- **🔗 Quick links** - Direct access to PyPI, docs, and source code +- **Package description** - What the package does +- **Latest version** - Current stable release +- **Python compatibility** - Supported Python versions +- **Version history** - Recent releases with dates +- **Quick links** - Direct access to PyPI, docs, and source code - **⚠️ Deprecation warnings** - Know if packages are deprecated **Example:** @@ -35,7 +35,7 @@ HTTP library for Python 🔗 PyPI | Documentation | GitHub ``` -### ⚡ Intelligent Version Completion +### Intelligent Version Completion Smart version suggestions as you type: @@ -62,7 +62,7 @@ dependencies = [ 1.23.5 ❌ (Yanked) ``` -### 🔄 Smart Caching System +### Smart Caching System Optimized performance with intelligent caching: @@ -79,7 +79,7 @@ Optimized performance with intelligent caching: - **Cached hover**: ~5-10ms (instant) - **Cache hit rate**: ~95% in typical usage -### 📦 Universal Format Support +### Universal Format Support Works with all Python packaging standards: @@ -123,7 +123,7 @@ Works with all Python packaging standards: ## Advanced Features -### 🛡️ Error Prevention +### Error Prevention Catch common issues before they happen: @@ -132,7 +132,7 @@ Catch common issues before they happen: - **Deprecated package detection** - Alerts for deprecated packages - **Yanked version warnings** - Prevents using withdrawn releases -### 🎨 Visual Indicators +### Visual Indicators Clear visual feedback in your editor: @@ -142,7 +142,7 @@ Clear visual feedback in your editor: - **⚠️ Deprecation warnings** - Alerts for deprecated packages - **📍 Status bar integration** - Current operation status -### 🔍 Quick Actions +### Quick Actions Right-click context menu actions: @@ -152,7 +152,7 @@ Right-click context menu actions: - **View on PyPI** - Open package page in browser - **Copy version** - Copy version strings to clipboard -### ⌨️ Keyboard Shortcuts +### Keyboard Shortcuts Efficient keyboard-driven workflow: @@ -228,16 +228,16 @@ Tombo understands these dependency sections: ### Privacy First Design -- **🔒 Zero telemetry** - No usage tracking -- **🏠 Local processing** - Data stays on your machine -- **🌐 Optional networking** - Only for package lookups -- **🔑 No accounts required** - Works without registration +- **Zero telemetry** - No usage tracking +- **Local processing** - Data stays on your machine +- **Optional networking** - Only for package lookups +- **No accounts required** - Works without registration ### Security Features -- **✅ HTTPS only** - Secure PyPI connections -- **🛡️ Input validation** - Prevents malicious input -- **🔍 Source verification** - Validates package data +- **HTTPS only** - Secure PyPI connections +- **Input validation** - Prevents malicious input +- **Source verification** - Validates package data - **⚡ Minimal permissions** - Least privilege principle ## Extensibility diff --git a/docs/docs/index.md b/docs/docs/index.md index e5df4d9..fd2f638 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -4,6 +4,7 @@ Tombo revolutionizes Python dependency management by bringing rich PyPI integration directly to your editor. Get instant version completion, hover information, and smart caching - all while supporting modern Python packaging standards. +
- :fontawesome-solid-rocket:{ .lg .middle } __Ready in Seconds__ @@ -86,27 +87,36 @@ Tombo revolutionizes Python dependency management by bringing rich PyPI integrat ## Key Features -**🎯 Rich Hover Cards** +**Rich Hover Cards** : Hover over any package → see versions, Python compatibility, descriptions, and PyPI links **⚡ Version Completion** : Type version constraints → get intelligent suggestions with compatibility info -**🔄 Smart Caching** +**Smart Caching** : 90% API call reduction with LRU+TTL caching - works offline after first lookup -**📦 Universal Format Support** +**Universal Format Support** : PEP 621, Poetry v1/v2, requirements.txt - covers all Python packaging standards -**🛡️ Privacy Focused** +**Privacy Focused** : MIT licensed, no telemetry, no accounts - completely free and open source ## Quick Demo -1. **Open any Python project** with `pyproject.toml` or `requirements.txt` -2. **Hover over a package name** → Rich metadata appears instantly -3. **Start typing version constraints** → Get intelligent completion -4. **Click PyPI links** → Jump to documentation without leaving VS Code +See Tombo in action - the perfect complement to uv/poetry for version selection: + + + +**What you see:** +1. **The Problem**: `uv add apache-airflow==3.0.5` fails (yanked version) +2. **The Solution**: Open VS Code with Tombo +3. **Version Intelligence**: Type `apache-airflow==` → see all available versions +4. **Smart Selection**: Choose 3.0.6 (working version) +5. **Rich Information**: Hover to understand why 3.0.5 was yanked ## Getting Started