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

Adds docs for the AI features errors #309

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

Jordi-PV
Copy link

@Jordi-PV Jordi-PV commented Jun 27, 2024

Summary

This PR documents the errors that the Yoast AI features display.

Relevant technical choices

Technical choices that affect more than this issue:

None.

Test instructions

This PR can be acceptance tested by following these steps:

  1. Open up https://document-ai-error-messages.yoast-developer.pages.dev/features/ai/ai-errors/
  2. Read through and confirm everything is covered / readable.

Quality assurance

  • Security - I have thought about any security implications this code might add.
  • Performance - I have checked that this code doesn't impact performance (greatly).
  • Caching - I have analyzed the caching methods that this code touches and have added instructions to deal with those.
  • Tested - I have tested this code to the best of my abilities.
  • Automated tests - I have added unit tests to verify the code works as intended.
  • Testability - I have added unique ids to elements, so they can be located in automated testing.
  • I have altered a filename.
    • I have adjusted the ID property accordingly and updated all internal links.
    • I have added the redirect to the _redirects file in the root of the project.

@Jordi-PV Jordi-PV marked this pull request as draft June 27, 2024 15:26
Copy link

cloudflare-workers-and-pages bot commented Jun 27, 2024

Deploying yoast-developer with  Cloudflare Pages  Cloudflare Pages

Latest commit: 387fffe
Status:🚫  Build failed.

View logs

@Jordi-PV Jordi-PV marked this pull request as ready for review June 28, 2024 08:35
@Jordi-PV Jordi-PV marked this pull request as draft July 2, 2024 09:18
Copy link
Contributor

@mhkuu mhkuu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice to see some documentation for this! 🎉 Here are some initial suggestions.

I would love to see more information on other possible errors:

  • site unreachable
  • inactive license
  • generic errors
  • ... basically every error listed in assets/js/src/ai-generator/components/errors

docs/features/ai/ai-errors.md Outdated Show resolved Hide resolved
docs/features/ai/ai-errors.md Outdated Show resolved Hide resolved
docs/features/ai/ai-errors.md Outdated Show resolved Hide resolved
sidebars.js Outdated Show resolved Hide resolved
@mhkuu mhkuu marked this pull request as ready for review July 24, 2024 11:56
@marinakoleva marinakoleva requested review from marinakoleva and removed request for marinakoleva August 1, 2024 06:36
@marinakoleva marinakoleva self-assigned this Aug 1, 2024
@marinakoleva
Copy link

  • Swapped all mentions of "alert" or "alert modal" to "error message" (slack thread)
  • We could add slightly bigger images so that the error text is easier to read. I changed the first image as an example.
  • We could also add the text of the error to make it possible to copy it when needed, or to help with reading it. Again, an example was added to the first error.
  • Because the text of some error messages seems a bit unclear/ unhelpful, another task was created to improve them: Update copy and links of error messages
  • Crucially, I wonder whether this page is necessary to exist, given that we already have the page Common AI feature problems and errors on yoast.com. What we could do instead, is revamp the yoast.com page, and add the information and images on this page there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants