Refine plugin registry README preview and browse density #202

Closed
opened 2026-06-01 16:24:00 +00:00 by steve · 0 comments
Owner

Plugin registry detail README rendering currently uses a custom fetched HTML
surface, and the Browse card list is more visually busy than the registry
source card view. Both should better match the app: use the app markdown preview
component for README content, and keep Browse cards dense with only essential
metadata.

Problem

The Browse plugin details modal should render plugin README markdown through the
same markdown preview component used by the app rather than a custom prose
HTML block. The initial Browse listing should also be denser and less badge-heavy
so users can scan more plugins at once.

Goal

Use the existing markdown preview surface for plugin registry README content and
make the initial Browse card grid more compact, ideally supporting three columns
at full settings width.

Scope

  • Fetch and render the registry-hosted README markdown artifact through the app
    markdown preview/embed component.
  • Keep README load/error states independent from install, enable, update, and
    uninstall actions.
  • Adjust Browse card layout for a denser responsive grid with up to three
    columns where space permits.
  • Limit badges on Browse cards to official status and last-updated information;
    move richer category/platform/install-state badges to the details view.
  • Update the workspace and registry specs to describe the README markdown
    preview rendering path and denser Browse card contract.

Non-goals

  • Changing registry signing, install, update, or provenance semantics.
  • Adding a new markdown renderer.
  • Adding editable README behavior.

Acceptance Criteria

  • Plugin registry detail README content renders through the existing app
    markdown preview component.
  • The details modal no longer uses a custom prose/raw HTML README renderer.
  • README load failures still show a documentation-only error and do not block
    plugin actions.
  • Browse results render in a denser responsive card grid, using three columns
    when the settings modal width allows.
  • Browse cards show only the official badge and last updated time as badges or
    compact metadata; category/platform/install-state badges are available from
    the details screen instead.
  • Workspace/package specs reflect the README markdown preview and dense browse
    behavior.
  • Relevant workspace checks, spec lint/build, smoke, and backlog commit
    verification pass.

Implementation Notes

Likely files:

  • packages/workspace/src/lib/components/configuration/plugins-registry-panel.svelte
  • packages/workspace/src/lib/components/configuration/plugin-readme.ts
  • packages/workspace/spec.md
  • spec/src/20-packages/workspace/index.md
  • spec/src/30-cross-package-contracts/plugin-registry.md

Suggested Files or Specs To Inspect

  • spec/src/20-packages/workspace/index.md
  • spec/src/30-cross-package-contracts/plugin-registry.md
  • spec/src/30-cross-package-contracts/editor-and-views.md
  • spec/src/20-packages/plugins/markdown/index.md
  • packages/plugins/plugin-markdown/src/

Validation Commands

  • pnpm --filter @lapis-notes/workspace check:svelte
  • pnpm --filter @lapis-notes/workspace check:format
  • pnpm --filter @lapis-notes/workspace check:types
  • pnpm --filter @lapis-notes/workspace check:all
  • make spec-lint
  • mdbook build spec
  • pnpm test:smoke

Follow-up Tasks

Implementation Summary

Rendered registry README markdown through the app MarkdownPreview component, resolved README-relative URLs before preview rendering, made Browse cards denser with a three-column layout at full settings width, and moved category/platform/extra badges to the detail modal.

Plugin registry detail README rendering currently uses a custom fetched HTML surface, and the Browse card list is more visually busy than the registry source card view. Both should better match the app: use the app markdown preview component for README content, and keep Browse cards dense with only essential metadata. ## Problem The Browse plugin details modal should render plugin README markdown through the same markdown preview component used by the app rather than a custom `prose` HTML block. The initial Browse listing should also be denser and less badge-heavy so users can scan more plugins at once. ## Goal Use the existing markdown preview surface for plugin registry README content and make the initial Browse card grid more compact, ideally supporting three columns at full settings width. ## Scope - Fetch and render the registry-hosted README markdown artifact through the app markdown preview/embed component. - Keep README load/error states independent from install, enable, update, and uninstall actions. - Adjust Browse card layout for a denser responsive grid with up to three columns where space permits. - Limit badges on Browse cards to official status and last-updated information; move richer category/platform/install-state badges to the details view. - Update the workspace and registry specs to describe the README markdown preview rendering path and denser Browse card contract. ## Non-goals - Changing registry signing, install, update, or provenance semantics. - Adding a new markdown renderer. - Adding editable README behavior. ## Acceptance Criteria - Plugin registry detail README content renders through the existing app markdown preview component. - The details modal no longer uses a custom `prose`/raw HTML README renderer. - README load failures still show a documentation-only error and do not block plugin actions. - Browse results render in a denser responsive card grid, using three columns when the settings modal width allows. - Browse cards show only the official badge and last updated time as badges or compact metadata; category/platform/install-state badges are available from the details screen instead. - Workspace/package specs reflect the README markdown preview and dense browse behavior. - Relevant workspace checks, spec lint/build, smoke, and backlog commit verification pass. ## Implementation Notes Likely files: - `packages/workspace/src/lib/components/configuration/plugins-registry-panel.svelte` - `packages/workspace/src/lib/components/configuration/plugin-readme.ts` - `packages/workspace/spec.md` - `spec/src/20-packages/workspace/index.md` - `spec/src/30-cross-package-contracts/plugin-registry.md` ## Suggested Files or Specs To Inspect - `spec/src/20-packages/workspace/index.md` - `spec/src/30-cross-package-contracts/plugin-registry.md` - `spec/src/30-cross-package-contracts/editor-and-views.md` - `spec/src/20-packages/plugins/markdown/index.md` - `packages/plugins/plugin-markdown/src/` ## Validation Commands - `pnpm --filter @lapis-notes/workspace check:svelte` - `pnpm --filter @lapis-notes/workspace check:format` - `pnpm --filter @lapis-notes/workspace check:types` - `pnpm --filter @lapis-notes/workspace check:all` - `make spec-lint` - `mdbook build spec` - `pnpm test:smoke` ## Related Issues - Follow-up to #201 — [Render plugin registry browse entries as cards](../closed/201-render-plugin-registry-browse-entries-as-cards.md) ## Follow-up Tasks ## Implementation Summary Rendered registry README markdown through the app MarkdownPreview component, resolved README-relative URLs before preview rendering, made Browse cards denser with a three-column layout at full settings width, and moved category/platform/extra badges to the detail modal. <!-- backlog:task_id=TASK-PLUGIN-REGISTRY-README-MARKDOWN-PREVIEW source_spec=spec/src/50-roadmap/full-registry-v1.md related_issue=201 -->
steve added this to the Full Registry V1 milestone 2026-06-01 16:24:00 +00:00
steve changed title from Render plugin registry README with markdown preview to Refine plugin registry README preview and browse density 2026-06-01 16:25:49 +00:00
steve 2026-06-01 16:45:43 +00:00
  • closed this issue
  • added
    done
    and removed
    open
    labels
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
lapis-notes/lapis#202
No description provided.