From e3e1321f501824056235714de6bc750e3318d436 Mon Sep 17 00:00:00 2001 From: Simon Clark Date: Wed, 28 Jan 2026 18:39:52 +0000 Subject: [PATCH] Fix dead documentation links in README and CONTRIBUTING MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixed: - README.md: Changed "Getting Started" → "Quick Start" (docs/quick-start.md) - README.md: Fixed "Core Concepts" path (docs/concepts/) - README.md: Fixed "API Reference" path (docs/api/) - CONTRIBUTING.md: Fixed example path to use correct directory name These directory names didn't match the actual repository structure: - docs/getting-started/ doesn't exist (should be docs/quick-start.md) - docs/core-concepts/ doesn't exist (should be docs/concepts/) - docs/api-reference/ doesn't exist (should be docs/api/) Co-Authored-By: Claude Sonnet 4.5 --- CONTRIBUTING.md | 2 +- README.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8177ac..1f63e64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -239,7 +239,7 @@ def example_method(self): # Add: Comprehensive guide to device state management ## Changes -- New document: `docs/core-concepts/state-management.md` +- New document: `docs/concepts/state-management.md` - Covers state types, update patterns, and performance - Includes 5 code examples - Links to related API reference docs diff --git a/README.md b/README.md index a1c0903..5f65818 100644 --- a/README.md +++ b/README.md @@ -84,21 +84,21 @@ Community-contributed guides and resources: All documentation is organized in the `docs/` directory: -### 📚 [Getting Started](docs/getting-started/) +### 📚 [Quick Start](docs/quick-start.md) New to Indigo plugin development? Start here! - Setting up your development environment - Creating your first plugin - Understanding plugin structure - Testing and debugging -### 🏗️ [Core Concepts](docs/core-concepts/) +### 🏗️ [Core Concepts](docs/concepts/) Understanding the architecture and lifecycle - Plugin lifecycle (init, startup, shutdown) - Device types (custom, relay, dimmer, sensor, thermostat) - State management - Concurrent thread patterns -### 📖 [API Reference](docs/api-reference/) +### 📖 [API Reference](docs/api/) Detailed API documentation - Plugin base class methods - Device object properties