Website content checks

[patrickdemooij9]

Just writing this down here to start a conversation about this.

Most SEO package allow you to perform some automated checks while editing your content. Simple examples can be:

• Size of the title field
• Size of the description field

Currently SeoToolkit doesn't really have this. It does have the SiteAudit package, but that currently only allows you to run audits across your entire website and isn't really something that you would do while you are editing your content. I think these so called "Seo checks" should work like this:

• These checks shouldn't be only be metafields specific. While metafields specific checks are able to be shown straight away, it doesn't say enough about the whole page. Ideally the page should be rendered with the given content and then used as source for the checks. This does mean that the user first needs to save/publish the content.
• Easily visible while editing your SEO content. These checks will most likely be something that an user would check before they publish their content. I think a new tab next to the meta fields could be a nice place to add these checks

I think a first version would include the following checks:

• Metafields (Are they filled and correct size?)
• Image alt (Are they filled?)
• Broken links (Any broken links on the page?)
• Missing headers?
  Each of these checks should be able to be turned off or on depending on what the development team would like to use.

And I think this should be part of the SiteAudit package with an option for the MetaFields package to easily integrate with it.

This is a rough sketch of what I am thinking about regarding these Seo checks. Please let me know how you think about it and if you see any issues or improvements with the above approach. I would love to hear the use cases that you see with different clients.

Thank you!

[timoschraa]

Hey Patrick,

I think this is a good start! A few remarks:

• Are metafields filled and correct size: perfect suggestion.
• Are image alt descriptions set is a difficult one, because if images are for decorative purposes only it's not required -> maybe display a list of images with their alt?
• Broken links is a nice feature
• What do you mean with 'Missing headers' -> e.g. if there is an H1 tag?
• Maybe some edits about the contents of the page? E.g. if there is an iframe on the page?

Indeed it would be nice to run the tests per page, e.g. while editing of on save instead of running the tests on the entire website.

For later versions of Umbraco the ContentAudit package could also be used for this or referenced as inspiration (https://rickbutterfield.dev/blog/contentaudit/).