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

Add documentation for Free, Premium, and other add-on assessments to developer.yoast.com

Abierto
  • ¿Algo no está bien?
#226 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
30/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript
Área
documentation

Línea de trabajo

Empieza inspeccionando la estructura existente en docs/features/analysis y las convenciones de documentación de Docusaurus. Usa como material de referencia los archivos vinculados SCORING SEO.md, SCORING READABILITY.md y SCORING INCLUSIVE LANGUAGE.md; se considera terminado cuando se hayan añadido assessments/overview.md, así como las carpetas y páginas específicas de las evaluaciones solicitadas, sin eliminar ni mover la documentación de yoastseo.

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.

All assessments:

In developer/docs/features/analysis create a folder called assessments.

overview.md

Within this folder create one overview.md with some general information and links to all assessment specific docs. Could also contain a legend/explanation of the card system (see below).

This should have a docusaurus header like so:

---
id: overview
title: "Assessments: Overview"
sidebar_label: Overview
description: This documentation provides a list of all our assessments.
---

This overview should contain a list of all (Free and Premium) SEO, Readability and Inclusive Language assessments by their type/source. And all assessments should link to the assessment specific page (see below). Note: there are separate tasks to add documentation related to add-ons and Shopify:

Example of how this will look:

SEO

Readability

Inclusive Language

Assessment specific pages

Within the assessments folder, create a folder for each assessment type/source. NOTE: use snake casing as this appears to be the convention withing developer.yoast.com. For example inclusive-language.

In each respective folder, create an .md file for each assessment. (Again, use snake casing: keyphrase-in-introduction.md)

Each file should have a Docusaurus header at the top. For example:

---
id: KeyphraseLengthAssessment
title: "Assessments: KeyphraseLengthAssessment"
sidebar_label: Keyphrase Length
description: This documentation provides an overview of the Keyphrase Length Assessment.
---

Docusaurus will interpret this header.

Each file could contain a card with some essential information in a structural format. This could also house some information from SCORING SEO.md, SCORING READABILITY.md and SCORING INCLUSIVE LANGUAGE.md that is not in the second card below. For example:

Keyphrase length
Name In Code KeyphraseLengthAssessment
Title URL: https://yoa.st/33i (link placement is in bold in the feedback strings)
Call to action URL https://yoa.st/33j (link placement is in bold in the feedback strings)
What it does Checks whether the number of ( content ) words in the keyphrase is within the recommended limit. For languages with function word support only content words are considered. For languages without function word support all words are considered.
Uses synonyms ❌
When it applies Always.
Addon/Premium ❌ <whether it is part of an addon or premium>
Languages Agnostic
Cornerstone ❌ <whether it is changed by cornerstone toggle>
Uses highlighting ❌
Uses morphology in premium ❌
Other <Any additional info that might be relevant.>

Below this card, create a card for scoring. This can be copied from SCORING SEO.md, SCORING READABILITY.md and SCORING INCLUSIVE LANGUAGE.md. For example

Bullet Score Criterion Feedback
Red -999 No focus keyword set Keyphrase length: No focus keyphrase was set for this page. Set a focus keyphrase in order to calculate your SEO score.
Red 3 Keyphrase length > 8 words (> 9 for languages without function words support) Keyphrase length: The keyphrase contains x (content) words. That's way more than the recommended maximum of 4 (content) words. Make it shorter!
Orange 6 Keyphrase length between 5-8 words (7-9 for languages without function words support) Keyphrase length: The keyphrase contains x (content) words. That's more than the recommended maximum of 4 (content) words. Make it shorter!
Green 9 Keyphrase length between 1-4 words (1-6 or languages without function words support) Keyphrase length: Good job!

Below this card there is space for free text/context/screenshots/desired behaviour.
Do not remove these cards from the yoastseo package. Also do not move any other documentation from the yoastseo package. There is a separate task to deal with that: https://github.com/Yoast/lingo-other-tasks/issues/211

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

Preparar el entorno

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.