Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
2 tasks done
hdvos opened this issue Mar 24, 2023 · 0 comments
Open
2 tasks done
Labels
documentation Improvements or additions to documentation

Comments

@hdvos
Copy link

hdvos commented Mar 24, 2023

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

@hdvos hdvos changed the title Create documentation on Supported Content types in docusaurus Create documentation on Supported Content types on developer.yoast.com Mar 24, 2023
@mhkuu mhkuu added the documentation Improvements or additions to documentation label Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants