@hustle-together/api-dev-tools 3.12.3 → 3.12.16

package/README.md

@@ -1,4 +1,4 @@
-# API Development Tools v1.0.0
+# API Development Tools v3.12.12
 
 ```
     ╔═══════════════════════════════════════════════════════════════╗
@@ -141,7 +141,7 @@ Combines multiple existing APIs into orchestrated endpoints:
 
 | Component         | Count | Purpose                                 |
 | ----------------- | ----- | --------------------------------------- |
-| Agent Skills      | 23    | Cross-platform workflow commands        |
+| Agent Skills      | 24    | Cross-platform workflow commands        |
 | Enforcement Hooks | 22    | Block progress until phases complete    |
 | Subagents         | 7     | Parallel research, schemas, tests, docs |
 | State Tracking    | 1     | Track progress across sessions          |
@@ -183,6 +183,63 @@ Notifications include:
 
 ---
 
+## API Showcase
+
+Interactive documentation and testing UI for all your APIs:
+
+```bash
+# Access at: http://localhost:3000/api-showcase
+```
+
+**Features:**
+- Grid view of all registered APIs with search and filtering
+- Click any API to open interactive testing modal
+- **Example Requests** - Pre-built, runnable examples that auto-fill query params
+- **Try It** - Live API testing with real responses
+- **Curl Examples** - Copy working curl commands
+- **Documentation** - File locations, schemas, parameters
+
+### How Examples Work
+
+Examples are generated from your Zod schema parameters during Phase 13 (Documentation):
+
+```json
+// In registry.json - auto-generated from schema
+"endpoints": {
+  "search": {
+    "params": [...],
+    "examples": {
+      "basic": {
+        "description": "Basic search request",
+        "query": "action=search&query=nature",
+        "curl": "curl -X GET 'http://localhost:3000/api/v2/unsplash?action=search&query=nature'"
+      }
+    }
+  }
+}
+```
+
+The showcase reads examples from `registry.json` and displays clickable buttons that auto-fill the request.
+
+---
+
+## TypeDoc Integration
+
+Generate API documentation from TSDoc comments:
+
+```bash
+pnpm typedoc           # Generate docs to docs/api/
+pnpm typedoc:watch     # Watch mode for development
+```
+
+TypeDoc runs during **Phase 13 (Documentation)** and generates Markdown documentation from:
+- `src/lib/schemas/*.ts` - Zod schemas with TSDoc comments
+- `src/app/api/**/*.ts` - API route handlers
+
+Configuration: `typedoc.json` (installed by the CLI)
+
+---
+
 ## Additional Commands
 
 ### TDD Workflow
@@ -214,13 +271,33 @@ Notifications include:
 
 ## Documentation
 
-| Document                                                       | Purpose                                                                                                                                                       |
-| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **[BEST_PRACTICES_ANALYSIS.md](./BEST_PRACTICES_ANALYSIS.md)** | Complete phase documentation with hook details, enforcement logic, and workflow diagrams. The authoritative reference for understanding how each phase works. |
-| **[INSTALLATION_GUIDE.md](./INSTALLATION_GUIDE.md)**           | Step-by-step setup instructions including manual installation, MCP configuration, environment variables, and troubleshooting.                                 |
-| **[.skills/README.md](./.skills/README.md)**                   | All 23 agent skills with usage examples, parameters, and cross-platform compatibility notes.                                                                  |
-| **[CHANGELOG.md](./CHANGELOG.md)**                             | Version history with features and release notes.                                                                                                              |
-| **[ROADMAP.md](./ROADMAP.md)**                                 | Future features and enhancement plans including Phase 14 code review, async research, and more.                                                               |
+### Core Reference
+
+| Document | Purpose |
+| -------- | ------- |
+| **[docs/SKILLS.md](./docs/SKILLS.md)** | Complete slash command reference - all 24+ skills with usage and examples |
+| **[docs/HOOKS.md](./docs/HOOKS.md)** | All 45+ enforcement hooks - what they do and when they run |
+| **[docs/AGENTS.md](./docs/AGENTS.md)** | Specialized subagents - parallel-researcher, schema-generator, etc. |
+| **[docs/ORCHESTRATOR.md](./docs/ORCHESTRATOR.md)** | Master workflow controller - /hustle-build, decomposition, shared decisions |
+| **[docs/REGROUNDING.md](./docs/REGROUNDING.md)** | 7-turn context refresh system - prevents "lost in the middle" problem |
+| **[docs/PLUGIN_ARCHITECTURE.md](./docs/PLUGIN_ARCHITECTURE.md)** | How the plugin system works - installation, state, lifecycle |
+| **[docs/CLAUDE_CODE_BEST_PRACTICES.md](./docs/CLAUDE_CODE_BEST_PRACTICES.md)** | Industry best practices for Claude Code - hooks, subagents, context engineering |
+| **[docs/GAP_ANALYSIS.md](./docs/GAP_ANALYSIS.md)** | How api-dev-tools implements best practices and what gaps remain |
+
+### Guides
+
+| Document | Purpose |
+| -------- | ------- |
+| **[INSTALLATION_GUIDE.md](./INSTALLATION_GUIDE.md)** | Step-by-step setup including MCP config, environment variables, troubleshooting |
+| **[BEST_PRACTICES_ANALYSIS.md](./BEST_PRACTICES_ANALYSIS.md)** | Phase documentation with workflow diagrams and enforcement logic |
+| **[.skills/README.md](./.skills/README.md)** | Agent Skills format compatibility and cross-platform notes |
+
+### Project Info
+
+| Document | Purpose |
+| -------- | ------- |
+| **[CHANGELOG.md](./CHANGELOG.md)** | Version history with features and release notes |
+| **[ROADMAP.md](./ROADMAP.md)** | Future features and enhancement plans |
 
 ---