game-ci / game-ci/documentation

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

Open
#288 4 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
MDX
Stars
243
Forks
130
Avg merge
15d 42m
Merged PRs (30d)
1

Description

![ScreenShot Firefox Developer Edition 2022-05-21 at 13 41 56@2x](https://user-images.githubusercontent.com/1264761/169663246-ea4a1146-23ee-4d86-b99c-cd0e5f5fa5e3.png)

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](https://developers.facebook.com/tools/debug/?q=https%3A%2F%2Fgame.ci) 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.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the metadata for the game.ci homepage and the /docs entry point. Compare the current description and sharing preview with the Facebook Debugger, then verify that the final metadata includes an improved description, sharing image, and appropriate documentation URL behavior.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, web-dev
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.