Skip to content

Documentation #42

@pento

Description

@pento

Update documentation across the repo to cover the WordPress plugin, channel architecture, and command protocol.

Plugin README

wordpress-plugin/readme.txt (already stubbed in #29) — flesh out with:

  • Description of what the plugin does
  • Requirements (WordPress 7.0+ or Gutenberg 22.8+, Claude Code with claudaborative-editing MCP)
  • Installation instructions (manual upload from bundled zip, or wordpress.org once listed)
  • Usage guide: sidebar panel, command palette, note actions
  • FAQ section

Repo README

Update the root README.md:

  • Mention the WordPress plugin and its purpose
  • Link to the plugin's readme for details
  • Update architecture diagram to include the plugin and channel layer

CLAUDE.md

Update CLAUDE.md with:

  • Plugin directory structure and build commands
  • Command protocol overview (REST endpoints, SSE, command lifecycle)
  • Channel capability and notification format
  • How the command listener works (SSE primary, polling fallback, independent of sync loop)
  • New tools (wp_update_command_status, wp_install_editor_plugin)
  • New MCP prompts if any (e.g., pre-publish-check from Pre-publish checks via Claude #34)

Acceptance Criteria

  • Plugin readme is complete and suitable for wordpress.org listing
  • Repo README references the plugin
  • CLAUDE.md covers the plugin architecture, command protocol, and new tools
  • All new build commands documented (npm run build in plugin, wp dist-archive, etc.)

Part of #28.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions