Skip to content

docs(editor-component-image): replace stub README with real package docs (DCMS-1834) - #1835

Merged
sempostma merged 1 commit into
mainfrom
docs/dcms-1834-editor-component-image-readme
Aug 5, 2026
Merged

sempostma merged 1 commit into
mainfrom
docs/dcms-1834-editor-component-image-readme

Conversation

@sempostma

Copy link
Copy Markdown
Member

Closes #1834

Replaces the generic "Docs coming soon!" placeholder in packages/decap-cms-editor-component-image/README.md with real documentation, verified against src/index.js:

  • Documents the 3 fields: image (image widget), alt, title
  • Documents the markdown pattern it matches/serializes: ![alt](src "title")
  • States it registers via CMS.registerEditorComponent / editorComponents

Pure docs change, no code touched.

Test plan

  • npm run type-check — pass
  • npm run lint — pass
  • npm test — pass (340/342 suites, pre-existing skips unrelated to this change)

@sempostma
sempostma merged commit 80a7ba5 into main Aug 5, 2026
2 checks passed
@sempostma
sempostma deleted the docs/dcms-1834-editor-component-image-readme branch August 5, 2026 13:45
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.

docs(editor-component-image): replace stub README with real package docs — DCMS-1834

1 participant