Create documentation for supported editors on developer.yoast.com
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
Research direction
Start by checking the blocked issue #226, then inspect developer/docs/features/analysis and existing Docusaurus pages. Create the editors/overview.md and editor-specific pages for Classic, Block, and Elementor, documenting supported assessments and relevant content types. Done means the pages use the requested front matter, link to assessment documentation, and cover the listed editor-specific notes.
Written by the indexing model from the issue text.
Description
Please give us a description of the issue
- I've read and understood the contribution guidelines.
- I've searched for any related issues and avoided creating a duplicate issue.
This task was created as part of this task: https://github.com/Yoast/non-dev-tasks/issues/39
See report in first comment to this task for context.
Blocked by https://github.com/Yoast/developer/issues/226
Supported editors
In developer/docs/features/analysis create a folder called editors.
overview.md
Within this folder we create one overview.md with some general information and links to all editor specific docs.
This should have a docusaurus header like so:
---
id: overview
title: "Editors: Overview"
sidebar_label: Overview
description: This documentation provides documentationon all our supported editors.
---
List of supported editors
- Classic
- Block
- Elementor
Editors specific pages.
Should have headers like such
---
id: classicEditor
title: "Editors: Classic editor"
sidebar_label: Classic Editor
description: This documentation provides information on the classic editor and what assessments are suopported and how.
---
This could contain a table of all Assessments (with hyperlink to their docusaurus page) and some additional information
For classic editor,
- Make notes about taxonomies also using Classic?
- Make notes about Woo products also using classic?
- Make notes about Shopify, which also uses tinyMCE?
For block editor,
- Make notes about Gutenberg being (in principle) the same as Block editor.
For Elementor,
- Make note about products in elementor.
| Assessment | Content type Specific config |
|---|---|
| Keyphrase in introduction | ❌ |
| Keyphrase length | ❌ |
| ... | ... |
Think about what other columns might be relevant to add to this overview.
- Dominant language
- JavaScript
- Stars
- 15
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Yoast/developer
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Typos Open
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
antfu-collective/icones#398 ·
-
ECmail.com Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
wesbos/burner-email-providers#554 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
radiantearth/stac-browser#1023 ·
-
HMR stops working Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
components-web-app/docs#92 ·