kandev/docs/plans/canvas-marketplace/task-07-distribution-docs.md

id, title, status, wave, depends_on, plan, requirements, acceptance_criteria, system_design

id	title	status	wave	depends_on	plan	requirements	acceptance_criteria	system_design
07-distribution-docs	Document canvas distribution	done	7	06-sharing-ui	plan.md	REQ-CANVASES-MARKETPLACE-002 REQ-CANVASES-MARKETPLACE-005 REQ-CANVASES-MARKETPLACE-006	AC-CANVASES-MARKETPLACE-002.1 AC-CANVASES-MARKETPLACE-002.4 AC-CANVASES-MARKETPLACE-005.1 AC-CANVASES-MARKETPLACE-005.3 AC-CANVASES-MARKETPLACE-006.4	../../specs/canvases/system-design/marketplace-sharing.md

Task 07: Document canvas distribution

Summary

Document the implemented canvas package, sharing, installation, and registry workflow. Keep public guides, registry instructions, and the embedded authoring reference consistent with the shipped contract and UI helper.

In scope

• Public canvas how-to: screenshot-free downloads, file/link/registry installation, permissions, independent copies, source modes, failure recovery.
• Canvas registry README examples. Previews belong to registry entries, not canvas package manifests.
• Manual GitHub repository/release/listing instructions; generic GitLab/Bitbucket bundle-hosting instructions that do not imply official registry support.
• Embedded authoring guide for retained source, screenshot-free distribution compatibility, and bounded files; preserve core inventory/read count.
• Scoped engineering-guide updates only where implementation changes conventions.
• Synchronize the new package's results/status and link related designs after each assigned check passes. Preserve older packages' recorded evidence.

Out of scope

Publishing docs to another repository, submitting a registry entry, creating a remote repository, adding generated promotional images, or a generic QA audit.

Acceptance

• A reader can follow one complete manual export-to-repository-to-registry path, and can alternatively send a bundle file/direct URL without registry admission.
• Package examples match the production inspector, source and permissions. Registry examples show required canvas image URLs, including custom sources; docs never require images for bundle creation.
• Public/embedded references, UI helper steps, and implemented contract agree; documentation validators and authoring inventory tests pass.

Verification

rtk proxy node --test scripts/validate-public-docs.test.mjs
rtk proxy node scripts/validate-public-docs.mjs
(cd apps/backend && rtk go test ./internal/mcp/canvasskill ./cmd/canvas-package -count=1)
(cd apps/web && rtk pnpm exec vitest run components/settings/canvas-share-help.test.tsx)
rtk proxy python3 scripts/lint-spec-files.test.py
rtk proxy python3 scripts/lint-spec-files.py --all
rtk git diff --check -- docs plugin-registry/README.md apps/backend/internal/mcp/canvasskill

Validate documented package examples through inspector fixtures; do not publish anything to prove documentation. Re-run UI E2E only if helper behavior or other rendered UI changed in this task.

Files likely touched

• docs/public/canvases.md (how-to)
• Canvas sections of plugin-registry/README.md
• apps/backend/internal/mcp/canvasskill/files/SKILL.md, references/manifest.md, references/security.md, inventory tests as needed
• apps/backend/AGENTS.md, apps/web/AGENTS.md if new conventions need recording
• docs/specs/canvases/, this plan/work orders
• Audit root README.md and docs/screenshots.md; change only stale descriptions.

Dependencies

Tasks 01-06 and their exact recorded results.

Risks

Do not document proposed behavior as shipped before implementation. Existing source download means the retained project, not a reconstruction of missing build inputs. The official registry uses GitHub releases; host-neutral manual sharing does not broaden that registry contract.

Parallelism

sequential

Inputs

• All six requirements and the final system design.
• /docs-maintainer and the public-document validation guide.
• Current registry README, public canvas page, and UI-04 instructions.
• Existing canvas authoring core/scaffold inventory tests.

Results

Updated the public canvas and authoring guides, the canvas portions of the registry README, and the embedded authoring references. The documentation keeps screenshots as registry metadata and documents screenshot-free sharing, source modes, permissions, manual publication, and direct installation.

Verification: public-doc tests passed 62 tests and validated 46 published docs; specification lint passed; the embedded authoring skill suite passed 7 tests; and diff/whitespace checks passed.