Rewrite official plugin registry READMEs #200

New issue

Closed

opened 2026-06-01 15:48:19 +00:00 by steve · 0 comments

steve commented

2026-06-01 15:48:19 +00:00

Owner

Rewrite the README files used by the official plugin registry so they read as
user-facing feature detail pages instead of package maintenance notes.

Problem

The published plugin READMEs currently include package names, script snippets,
and internal spec links. Those are useful for contributors but read poorly in
the registry and app plugin detail screens.

Goal

Provide polished, registry-friendly README content for all currently published
official external plugins, with examples and markdown structure that renders
well in the registry and plugin manager.

Scope

Rewrite the READMEs for Canvas, Docs, Graph, Markdown Lint, Notebook, PDF,
Slides, and Telemetry.
Keep content user-facing and avoid markdown hyperlinks or internal wiki/spec
links.
Use headings, lists, blockquotes, tables, and short examples where useful.

Non-goals

Do not change plugin metadata, versions, manifests, or registry entries.
Do not update bundled-only plugin READMEs.
Do not add screenshots in this pass.

Acceptance Criteria

Published plugin README content describes functionality and example use cases.
README content contains no markdown links or internal links.
README formatting exercises useful markdown surfaces for the registry/app
renderer.
Relevant checks pass.

Implementation Notes

These READMEs feed the registry-hosted README artifacts during registry site
builds via readmeUrl.

Suggested Files or Specs To Inspect

packages/plugins/plugin-canvas/README.md
packages/plugins/plugin-docs/README.md
packages/plugins/plugin-graph/README.md
packages/plugins/plugin-markdown-lint/README.md
packages/notebook/README.md
packages/plugins/plugin-pdf/README.md
packages/plugins/plugin-slides/README.md
packages/plugins/plugin-telemetry/README.md

Validation Commands

pnpm --filter @lapis-notes/workspace check:all
pnpm --filter @lapis-notes/api check:all
make spec-lint
mdbook build spec

Follow-up to #199 — Publish registry-hosted plugin README artifacts

Follow-up Tasks

Implementation Summary

Refined the published official plugin README copy to focus on supported functionality, keeping examples only where they demonstrate actual plugin syntax or behavior.

Reopen Reason

Refine README copy from the last change: remove nonsensical examples and focus on supported plugin functionality.

Rewrite the README files used by the official plugin registry so they read as user-facing feature detail pages instead of package maintenance notes. ## Problem The published plugin READMEs currently include package names, script snippets, and internal spec links. Those are useful for contributors but read poorly in the registry and app plugin detail screens. ## Goal Provide polished, registry-friendly README content for all currently published official external plugins, with examples and markdown structure that renders well in the registry and plugin manager. ## Scope - Rewrite the READMEs for Canvas, Docs, Graph, Markdown Lint, Notebook, PDF, Slides, and Telemetry. - Keep content user-facing and avoid markdown hyperlinks or internal wiki/spec links. - Use headings, lists, blockquotes, tables, and short examples where useful. ## Non-goals - Do not change plugin metadata, versions, manifests, or registry entries. - Do not update bundled-only plugin READMEs. - Do not add screenshots in this pass. ## Acceptance Criteria - Published plugin README content describes functionality and example use cases. - README content contains no markdown links or internal links. - README formatting exercises useful markdown surfaces for the registry/app renderer. - Relevant checks pass. ## Implementation Notes These READMEs feed the registry-hosted README artifacts during registry site builds via `readmeUrl`. ## Suggested Files or Specs To Inspect - `packages/plugins/plugin-canvas/README.md` - `packages/plugins/plugin-docs/README.md` - `packages/plugins/plugin-graph/README.md` - `packages/plugins/plugin-markdown-lint/README.md` - `packages/notebook/README.md` - `packages/plugins/plugin-pdf/README.md` - `packages/plugins/plugin-slides/README.md` - `packages/plugins/plugin-telemetry/README.md` ## Validation Commands - `pnpm --filter @lapis-notes/workspace check:all` - `pnpm --filter @lapis-notes/api check:all` - `make spec-lint` - `mdbook build spec` ## Related Issues - Follow-up to #199 — [Publish registry-hosted plugin README artifacts](../closed/199-publish-registry-hosted-plugin-readme-artifacts.md) ## Follow-up Tasks ## Implementation Summary Refined the published official plugin README copy to focus on supported functionality, keeping examples only where they demonstrate actual plugin syntax or behavior. ## Reopen Reason Refine README copy from the last change: remove nonsensical examples and focus on supported plugin functionality.

steve added this to the Full Registry V1 milestone

2026-06-01 15:48:19 +00:00

steve

2026-06-01 15:48:19 +00:00