codex-team/editor.js

Outdated documentation on block Settings

Open

#2,616 opened on 2024年2月14日

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

説明

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.

コントリビューターガイド

技術スタック
typescriptjavascript
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic knowledge of Editor.jsfamiliarity with documentation tools
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90
調査方針
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.