Create documentation for supported editors on developer.yoast.com
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- javascript
调研方向
首先检查被阻塞的 issue #226,然后查看 developer/docs/features/analysis 和现有的 Docusaurus 页面。创建 editors/overview.md 以及 Classic、Block 和 Elementor 的编辑器专属页面,记录受支持的 assessment 和相关内容类型。当这些页面使用所要求的 front matter、链接到 assessment 文档,并涵盖列出的编辑器专属说明时,即表示完成。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- JavaScript
- 星标
- 15
- 派生
- 23
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
Yoast/developer 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 78/100
-
难度 5/5 一周以上 新手友好度 25/100
-
Typos 未关闭
难度 2/5 1-3 小时 新手友好度 48/100
-
bug
难度 3/5 1-2 天 新手友好度 55/100
-
难度 4/5 3-5 天 新手友好度 35/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
antfu-collective/icones#398 ·
-
ECmail.com 未关闭
难度 1/5 1 小时以内 新手友好度 90/100
wesbos/burner-email-providers#554 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
radiantearth/stac-browser#1023 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 75/100
components-web-app/docs#92 ·