codex-team/editor.js

Outdated documentation on block Settings

Open

#2,616 opened on Feb 14, 2024

View on GitHub
 (1 comment) (2 reactions) (0 assignees)TypeScript (26,602 stars) (1,985 forks)batch import
good first issue

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

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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of Editor.jsfamiliarity with documentation tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Update the documentation page at https://editorjs.io/making a block settings/ to reflect the new renderSettings() syntax. Refer to https://codex.so/editorjs menu config and https://codex.so/toggle groups for the correct approach. Ensure the documentation matches the current API and update any outdated code examples or descriptions. Check the repository's documentation contribution guidelines for formatting and submission process.