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

Create documentation on Supported Content types on developer.yoast.com

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

Nadie ha tomado este issue todavía.

Evaluación

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

Línea de trabajo

Revisa primero developer/docs/features/analysis y los requisitos de documentación del issue 226, ya que esta tarea está bloqueada por enlaces a esas páginas. Crea la carpeta content-types con overview.md y páginas específicas de cada tipo usando el front matter de Docusaurus mostrado. La tarea estará terminada cuando la vista general enlace a cada tipo compatible y las páginas documenten las evaluaciones disponibles en tablas claras.

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 because links need to created to pages that are created in that task.

Supported Content types

In developer/docs/features/analysis create a folder called content-types.

overview.md

Within this folder we create one overview.md with some general information about supported content types and links to all specific docs in docusaurus.

The overview should have a docusaurus header like such:

---
id: contentTypeOverview
title: "Content Types: Overview"
sidebar_label: overview
description: This documentation provides an overview of the different content types we support.
---

List of content types:

  • Post/Page/CPT
  • taxonomy
  • product/Shopify Product
  • ...
content type specific pages.
---
id: postPageCPT
title: "Content Types: Post/Page/CPT"
sidebar_label: Post/Page/CPT
description: This documentation provides information on what assessments are available for Posts/Pages/CPTs and how they are available.
---

This could contain a table of all Assessments (with hyperlink to their docusaurus page that was created in https://github.com/Yoast/developer/issues/226) and some additional information

Assessment Content type Specific config
Keyphrase in introduction ❌
Keyphrase length ❌
... ...

Think about whether other columns might be applicable to the table.

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.