codex-team/editor.js

Outdated documentation on block Settings

Open

#2,616 opened on Feb 14, 2024

View on GitHub
 (0 comments) (2 reactions) (0 assignees)TypeScript (1,985 forks)batch import
good first issue

Repository metrics

Stars
 (26,602 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hello, This part of the documentation is not up to date: https://editorjs.io/making-a-block-settings/

The correct approach now is this: https://codex.so/editorjs-menu-config and https://codex.so/toggle-groups o_7c6cff702d12786f1916d721944d95bd

There would therefore be a need for an update to the documentation to take into account the new renderSettings() syntax.

Thank you very much for your work.

Contributor guide

Research direction
Review the first linked documentation page (https://editorjs.io/making a block settings/) and update the content to reflect the new renderSettings() syntax using the provided links (https://codex.so/editorjs menu config and https://codex.so/toggle groups) as references. Update any outdated screenshots accordingly.
Tech stack
typescriptjavascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80