Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Create documentation for supported editors on developer.yoast.com

Abierto
#228 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript
Área
documentation

Línea de trabajo

Comienza revisando el issue bloqueado #226 y, a continuación, inspecciona developer/docs/features/analysis y las páginas existentes de Docusaurus. Crea editors/overview.md y páginas específicas para Classic, Block y Elementor que documenten las evaluaciones compatibles y los tipos de contenido relevantes. La tarea se considera completada cuando las páginas usan el front matter solicitado, enlazan a la documentación de las evaluaciones y cubren las notas específicas de cada editor indicadas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation
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.

Lenguaje dominante
JavaScript
Estrellas
15
Forks
23
Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Yoast/developer

Todos los issues de Yoast/developer

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.