From a4708aa13c3f382029125ecee01bbe404d69d3c4 Mon Sep 17 00:00:00 2001 From: Zhongwei Li Date: Sun, 30 Nov 2025 08:42:01 +0800 Subject: [PATCH] Initial commit --- .claude-plugin/plugin.json | 12 ++ README.md | 3 + plugin.lock.json | 49 +++++++ skills/claude-code-docs/SKILL.md | 31 ++++ .../claude-code-docs/reference/doc-topics.md | 133 ++++++++++++++++++ 5 files changed, 228 insertions(+) create mode 100644 .claude-plugin/plugin.json create mode 100644 README.md create mode 100644 plugin.lock.json create mode 100644 skills/claude-code-docs/SKILL.md create mode 100644 skills/claude-code-docs/reference/doc-topics.md diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json new file mode 100644 index 0000000..ef60f63 --- /dev/null +++ b/.claude-plugin/plugin.json @@ -0,0 +1,12 @@ +{ + "name": "claude-code-docs", + "description": "Claude Code documentation - auto-updating local docs with search skill", + "version": "1.2.0", + "author": { + "name": "Nathan Vale", + "email": "hi@nathanvale.com" + }, + "skills": [ + "./skills" + ] +} \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..2448bab --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# claude-code-docs + +Claude Code documentation - auto-updating local docs with search skill diff --git a/plugin.lock.json b/plugin.lock.json new file mode 100644 index 0000000..44d772d --- /dev/null +++ b/plugin.lock.json @@ -0,0 +1,49 @@ +{ + "$schema": "internal://schemas/plugin.lock.v1.json", + "pluginId": "gh:nathanvale/side-quest-marketplace:plugins/claude-code-docs", + "normalized": { + "repo": null, + "ref": "refs/tags/v20251128.0", + "commit": "f771a8989724bc492562d10bb92ffced34882db0", + "treeHash": "45818fb77b3aa406270e74bba557eb1fcb77d34a692af8351c5f3665d28c0443", + "generatedAt": "2025-11-28T10:27:15.471011Z", + "toolVersion": "publish_plugins.py@0.2.0" + }, + "origin": { + "remote": "git@github.com:zhongweili/42plugin-data.git", + "branch": "master", + "commit": "aa1497ed0949fd50e99e70d6324a29c5b34f9390", + "repoRoot": "/Users/zhongweili/projects/openmind/42plugin-data" + }, + "manifest": { + "name": "claude-code-docs", + "description": "Claude Code documentation - auto-updating local docs with search skill", + "version": "1.2.0" + }, + "content": { + "files": [ + { + "path": "README.md", + "sha256": "5273aaed7ed1493c9d2bd678ae597d2126e4322db84cf8901e50fb7b4e26a62e" + }, + { + "path": ".claude-plugin/plugin.json", + "sha256": "5c852206c1b038f7b529261fdfca08f46bdb79acb28bc977874a5dfa893f41c8" + }, + { + "path": "skills/claude-code-docs/SKILL.md", + "sha256": "2a0354a9031729389a800a47a378fef2311d6833a42a82ef4fb46a2856fa253c" + }, + { + "path": "skills/claude-code-docs/reference/doc-topics.md", + "sha256": "d4c31510b014e8a3d1f132dfd7935574ae0009bf647172f41f5a6c9f48622d2b" + } + ], + "dirSha256": "45818fb77b3aa406270e74bba557eb1fcb77d34a692af8351c5f3665d28c0443" + }, + "security": { + "scannedAt": null, + "scannerVersion": null, + "flags": [] + } +} \ No newline at end of file diff --git a/skills/claude-code-docs/SKILL.md b/skills/claude-code-docs/SKILL.md new file mode 100644 index 0000000..4571019 --- /dev/null +++ b/skills/claude-code-docs/SKILL.md @@ -0,0 +1,31 @@ +--- +name: claude-code-docs +description: Answers questions about Claude Code features, configuration, and usage from local documentation synced from code.claude.com. Use when users ask about hooks, plugins, skills, MCP servers, slash commands, sub-agents, settings, permissions, sandboxing, CLAUDE.md memory files, model selection, costs, IDE integrations (VS Code, JetBrains), CI/CD (GitHub Actions, GitLab), or cloud providers (Bedrock, Vertex, Azure). +--- + +# Claude Code Documentation Expert + +Answer questions about Claude Code using local docs synced from code.claude.com. + +## Docs Location + +`plugins/claude-code-docs/docs/` - 46 markdown files covering all Claude Code features. + +## Workflow + +1. **Find the right doc**: Read `reference/doc-topics.md` for topic-to-file mapping +2. **Read the doc**: Read the relevant file from `plugins/claude-code-docs/docs/` +3. **Answer with citations**: Quote relevant sections, cite the doc filename + +## Quick Lookup + +If unsure which doc to read, check `docs/INDEX.md` for a full list. + +For detailed topic mapping, see [reference/doc-topics.md](reference/doc-topics.md). + +## Response Guidelines + +- Only state what's in the docs +- Always cite doc filenames +- Say "not covered in docs" if info isn't available +- Suggest `/claude-code-docs:update` if docs seem outdated diff --git a/skills/claude-code-docs/reference/doc-topics.md b/skills/claude-code-docs/reference/doc-topics.md new file mode 100644 index 0000000..07504b6 --- /dev/null +++ b/skills/claude-code-docs/reference/doc-topics.md @@ -0,0 +1,133 @@ +# Documentation Topics Reference + +Quick reference mapping topics to documentation files. Use this to quickly find the right doc. + +## Table of Contents + +- [Core Concepts](#core-concepts) +- [Extending Claude Code](#extending-claude-code) +- [Configuration](#configuration) +- [Security](#security) +- [IDE Integrations](#ide-integrations) +- [CI/CD & Automation](#cicd--automation) +- [Cloud Providers](#cloud-providers) +- [Advanced Features](#advanced-features) +- [Help & Troubleshooting](#help--troubleshooting) +- [Keyword to Doc Mapping](#keyword-to-doc-mapping) + +## Core Concepts + +| Doc File | Topics Covered | +|----------|----------------| +| overview.md | What is Claude Code, key features, capabilities | +| quickstart.md | Installation, first run, basic usage | +| setup.md | Environment setup, API keys, configuration | +| interactive-mode.md | Interactive CLI usage, conversation flow | + +## Extending Claude Code + +| Doc File | Topics Covered | +|----------|----------------| +| hooks.md | Hook types (PreToolUse, PostToolUse, etc.), hook format, examples | +| hooks-guide.md | Step-by-step hook creation, common patterns, debugging | +| plugins.md | Plugin system, creating plugins, plugin structure | +| plugins-reference.md | Plugin manifest format, all plugin options | +| plugin-marketplaces.md | Installing from marketplaces, publishing plugins | +| skills.md | Agent Skills, SKILL.md format, allowed-tools | +| slash-commands.md | Custom slash commands, command files | +| sub-agents.md | Subagents, Task tool, agent types | +| mcp.md | MCP servers, configuration, available servers | + +## Configuration + +| Doc File | Topics Covered | +|----------|----------------| +| settings.md | All settings, settings.json, scopes (user/project) | +| cli-reference.md | CLI flags, environment variables, commands | +| memory.md | CLAUDE.md files, context injection, memory hierarchy | +| model-config.md | Model selection, opus/sonnet/haiku, model flags | +| iam.md | Permissions, tool access, allowlists, enterprise policies | +| terminal-config.md | Terminal integration, shell configuration | +| network-config.md | Proxy settings, network configuration | +| output-styles.md | Output formatting, verbose mode, streaming | +| statusline.md | Status bar configuration | + +## Security + +| Doc File | Topics Covered | +|----------|----------------| +| security.md | Security model, best practices, threat model | +| sandboxing.md | Bash sandboxing, filesystem isolation | +| data-usage.md | Data handling, privacy, what data is sent | +| legal-and-compliance.md | Compliance, legal considerations | + +## IDE Integrations + +| Doc File | Topics Covered | +|----------|----------------| +| vs-code.md | VS Code extension, keybindings, features | +| jetbrains.md | JetBrains plugin, IntelliJ, WebStorm | +| desktop.md | Desktop app, native features | + +## CI/CD & Automation + +| Doc File | Topics Covered | +|----------|----------------| +| headless.md | Non-interactive mode, automation, scripting | +| github-actions.md | GitHub Actions integration, workflows | +| gitlab-ci-cd.md | GitLab CI/CD integration | +| sdk.md | Claude Code SDK, programmatic usage | + +## Cloud Providers + +| Doc File | Topics Covered | +|----------|----------------| +| amazon-bedrock.md | AWS Bedrock setup, IAM, regions | +| google-vertex-ai.md | Google Cloud Vertex AI setup | +| microsoft-foundry.md | Azure AI Foundry setup | +| llm-gateway.md | LLM gateway configuration, proxies | + +## Advanced Features + +| Doc File | Topics Covered | +|----------|----------------| +| checkpointing.md | Conversation checkpoints, state management | +| analytics.md | Usage analytics, telemetry | +| monitoring-usage.md | Usage monitoring, cost tracking | +| devcontainer.md | Dev containers, remote development | +| third-party-integrations.md | External tool integrations | +| claude-code-on-the-web.md | Web-based Claude Code | + +## Help & Troubleshooting + +| Doc File | Topics Covered | +|----------|----------------| +| troubleshooting.md | Common issues, debugging, error messages | +| common-workflows.md | Best practices, workflow examples | +| costs.md | Pricing, token usage, cost optimization | + +## Keyword to Doc Mapping + +Use these keywords to find the right doc: + +- **"hook", "PreToolUse", "PostToolUse"** → hooks.md, hooks-guide.md +- **"plugin", "marketplace"** → plugins.md, plugin-marketplaces.md +- **"skill", "SKILL.md"** → skills.md +- **"slash command", "/command"** → slash-commands.md +- **"MCP", "server", "tool"** → mcp.md +- **"agent", "subagent", "Task tool"** → sub-agents.md +- **"setting", "config", "settings.json"** → settings.md +- **"permission", "allow", "deny"** → iam.md +- **"sandbox", "isolation"** → sandboxing.md +- **"memory", "CLAUDE.md", "context"** → memory.md +- **"model", "opus", "sonnet", "haiku"** → model-config.md +- **"cost", "price", "token"** → costs.md +- **"VS Code", "extension"** → vs-code.md +- **"JetBrains", "IntelliJ"** → jetbrains.md +- **"GitHub Actions", "CI"** → github-actions.md +- **"GitLab", "CI/CD"** → gitlab-ci-cd.md +- **"headless", "non-interactive", "automation"** → headless.md +- **"Bedrock", "AWS"** → amazon-bedrock.md +- **"Vertex", "Google Cloud"** → google-vertex-ai.md +- **"Azure", "Foundry"** → microsoft-foundry.md +- **"error", "not working", "fix"** → troubleshooting.md