Yoast / Yoast/developer

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

Open
#227 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
JavaScript
Stars
15
Forks
23
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review developer/docs/features/analysis and the documentation requirements in issue 226 first, since this task is blocked on links to those pages. Create the content-types folder with overview.md and content-type-specific pages using the shown Docusaurus front matter. Done means the overview links to each supported type and the pages document available assessments in clear tables.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.