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 for supported editors on developer.yoast.com #228

Open
2 tasks done
hdvos opened this issue Mar 24, 2023 · 0 comments
Open
2 tasks done

Create documentation for supported editors on developer.yoast.com #228

hdvos opened this issue Mar 24, 2023 · 0 comments
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

Supported editors

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

overview.md

Within this folder we create one overview.md with some general information and links to all editor specific docs.

This should have a docusaurus header like so:

---
id: overview
title: "Editors: Overview"
sidebar_label: Overview
description: This documentation provides documentationon all our supported editors.
---

List of supported editors

  • Classic
  • Block
  • Elementor

Editors specific pages.

Should have headers like such

---
id: classicEditor
title: "Editors: Classic editor"
sidebar_label: Classic Editor
description: This documentation provides information on the classic editor and what assessments are suopported and how.
---

This could contain a table of all Assessments (with hyperlink to their docusaurus page) and some additional information

For classic editor,

  • Make notes about taxonomies also using Classic?
  • Make notes about Woo products also using classic?
  • Make notes about Shopify, which also uses tinyMCE?

For block editor,

  • Make notes about Gutenberg being (in principle) the same as Block editor.

For Elementor,

  • Make note about products in elementor.
Assessment Content type Specific config
Keyphrase in introduction
Keyphrase length
... ...

Think about what other columns might be relevant to add to this overview.

@hdvos hdvos changed the title Create documentation for supported editors in docusaurus Create documentation for supported editors 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