Skip to content

docs: add comprehensive plugin authoring and management guides - #66

Closed
sanchitrk wants to merge 5 commits into
canaryfrom
claude/project-thread-cjcor6
Closed

sanchitrk wants to merge 5 commits into
canaryfrom
claude/project-thread-cjcor6

Conversation

@sanchitrk

Copy link
Copy Markdown
Contributor

Add complete documentation for the CodeWork plugin system, covering installation, configuration, authoring, and troubleshooting.

Summary

This adds five new documentation pages under docs/plugins/ that comprehensively document how to use, configure, and build plugins for CodeWork. The guides cover the full plugin lifecycle from discovery through publication.

Key changes

  • Overview (index.mdx): High-level introduction to plugins, built-in plugins, plugin kinds, and FAQ
  • Install & Manage (install.mdx): CLI commands for adding, installing, updating, checking, and removing plugins; explains resolve-only loading and local development workflow
  • Configuration (configuration.mdx): Settings file structure, two kinds of entries (module vs configuration), options passing, path resolution, and plugin ordering
  • Build a Plugin (authoring.mdx): Complete guide to writing plugins from a simple local tool through published npm packages; covers tool registration, sandbox integration, hook patterns, prompt plugins, and publishing requirements
  • Troubleshooting (troubleshooting.mdx): Error slug reference with causes and fixes for entry validation, installation, and loading failures

Implementation details

  • Added Placeholder component (placeholder.tsx) to mark locations where screenshots/videos will be added later
  • Updated docs metadata (meta.json) to include the new plugins section under a "Customize" category
  • Integrated Placeholder component into the MDX rendering pipeline
  • All guides follow the existing documentation style and include cross-references between related pages
  • Examples reference the actual example plugins in the repository (extras/ directory)

https://claude.ai/code/session_011TYMJKMx7fnbFmfjDukDze

Overview, install and management, settings configuration, authoring
guide, and troubleshooting by error slug. Adds a Placeholder MDX
component for screenshots and videos still to come.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011TYMJKMx7fnbFmfjDukDze
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011TYMJKMx7fnbFmfjDukDze
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011TYMJKMx7fnbFmfjDukDze
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011TYMJKMx7fnbFmfjDukDze
… links

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011TYMJKMx7fnbFmfjDukDze
@sanchitrk
sanchitrk changed the base branch from main to canary October 11, 2026 03:04

Copy link
Copy Markdown
Contributor Author

Closing this PR. #67 replaces it: that PR merged these plugin docs pages into canary.


Generated by Claude Code

@sanchitrk sanchitrk closed this Oct 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants