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

Improve search engine description, listing and urls (SEO optimization) #288

Open
GabLeRoux opened this issue May 21, 2022 · 4 comments
Open
Labels
bug Something isn't working

Comments

@GabLeRoux
Copy link
Member

GabLeRoux commented May 21, 2022

ScreenShot Firefox Developer Edition 2022-05-21 at 13 41 56@2x

  1. Description could be a bit better, right now it's using page's content
  2. Link to /docs brings to a 404: https://game.ci/docs we can probably redirect this to /docs/introduction
  3. Improve sharing description and image. Facebook Debugger says there is no og:image tag so the sharing result on Facebook looks like this:

ScreenShot Firefox Developer Edition 2022-05-21 at 13 45 53@2x

I assume sharing on other platforms such as slack and discord will result in something similar.
@GabLeRoux
Copy link
Member Author

The following plugin might be helpful for the redirection:
https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects

@GabLeRoux
Copy link
Member Author

GabLeRoux commented May 21, 2022

There used to be a ogImage for Docusaurus v1. According to documentation for v2, this is now handled in theme configuration:
https://docusaurus.io/docs/migration/manual#footericon-copyright-ogimage-twitterimage-docssidenavcollapsible

Documentation for og:image:
https://docusaurus.io/docs/api/themes/configuration#meta-image

Documentation for metadata (site description, etc.):
https://docusaurus.io/docs/api/themes/configuration#metadata

@webbertakken
Copy link
Member

Nice catch!

Actually I think perhaps "introduction" should just link to /docs. We don't need a plugin for that.
Note that if google links to a redirect (3xx) instead of a real page (2xx) it'll be bad for your SEO ranking.
Either way, that would be solved when google reindexes the page I think.

I think I'd prefer to just have /docs/introduction be docs/index instead so that /docs works again.

@webbertakken webbertakken added the bug Something isn't working label May 21, 2022
@webbertakken
Copy link
Member

Fixed the 404.

I think if we're going to do SEO it might make sense to also install PWA. I have a config for that which already includes some meta stuff and icons.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants