codex-team/editor.js

Documentation for Inline Tools does not include a static "prepare" method

Open

#2,401 opened on Jul 4, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (26,602 stars) (1,985 forks)batch import
good first issueissue for docs

Description

Documentation for Inline Tools does not include a static "prepare" method, but it works: https://editorjs.io/inline-tools-api-1/

I think should add a line about it, as in the Block Tunes API: https://editorjs.io/block-tunes-api/

Contributor guide

Tech stack
typescript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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
familiarity with markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Review the Inline Tools API documentation at https://editorjs.io/inline tools api 1/. Note that it lacks mention of a static `prepare` method, while the Block Tunes API documentation at https://editorjs.io/block tunes api/ includes such a mention. Add a similar note to the Inline Tools page, referencing the `prepare` method's purpose and usage.