Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
#227 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
45/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
markdown
领域
documentation

调研方向

首先查看 developer/docs/features/analysis 和 issue 226 中的文档要求,因为此任务受限于指向这些页面的链接。使用所示的 Docusaurus front matter 创建 content-types 文件夹,其中包含 overview.md 和针对各内容类型的页面。完成标准是概览页面链接到每种受支持的类型,并且各页面通过清晰的表格记录可用的评估。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
JavaScript
星标
15
派生
23
PR 合并指标
30 天内没有已合并 PR

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Yoast/developer 的其他 Issue

查看 Yoast/developer 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。