Skip to content

feat: the site describes each page to search engines, with a sitemap - #79

Open
vdmkenny wants to merge 1 commit into
mainfrom
docs/site-seo
Open

vdmkenny wants to merge 1 commit into
mainfrom
docs/site-seo

Conversation

@vdmkenny

Copy link
Copy Markdown
Contributor
  • Titles end with "StarLancer mods for OpenReliant", which is what people search for: "Viper Mk II: StarLancer mods for OpenReliant". The browse script's titles for a category follow it.
  • Each page's description is cut to fit a search result, at a sentence or a word, so the long ones such as Master Recordings' no longer run on.
  • Every page names its canonical address, so ?category= and ?q= views count as the index.
  • Open Graph and Twitter tags: a link to a mod's page shows the mod's thumbnail as a large card, and the other pages show OpenReliant's icon.
  • sitemap.xml lists the index, the updates and every mod's page, each with the day of its latest release. robots.txt names it (robots.txt names the sitemaps of OpenReliant's sites openreliant.github.io#1).

Checked by running site.py locally: 39 mod pages, 35 with a thumbnail card.

People look for StarLancer mods, not OpenReliant's, and the pages didn't say StarLancer in their
titles, gave no canonical address, and showed nothing when linked in a chat. Each page's title
now ends with "StarLancer mods for OpenReliant", its description is cut to fit a search result,
it names its canonical address, and a link to a mod's page shows the mod's thumbnail.
sitemap.xml lists every page with the day of its latest release, and robots.txt at the root of
openreliant.github.io names it.
vdmkenny added a commit to OpenReliant/openreliant that referenced this pull request Oct 25, 2026
…1336)

- Titles name StarLancer: the landing page is "OpenReliant: play
StarLancer on Windows, macOS and Linux", and the docs' home "OpenReliant
docs: install, play and mod StarLancer". The landing page's description
is cut to fit a search result.
- Each docs page gets its own description, the start of its text
(`website/docs_hooks.py`), in place of one description for all 82 pages.
- Canonical addresses, Open Graph and Twitter tags on every page, with
OpenReliant's icon as the preview picture.
- schema.org data on the landing page: a free game application for
Windows, macOS and Linux, about StarLancer.
- The docs' sitemap dates each page by its last commit, so search
engines can tell what changed. Before, every page carried the build's
date. The Pages workflow fetches the whole history for it, without the
old files' contents.
- `website/sitemap.xml` lists the landing and contribute pages.
- The hero picture gives its size, so the page doesn't shift as it
loads.

Goes with OpenReliant/openreliant.github.io#1, robots.txt naming the
sitemaps, and OpenReliant/openreliant-mods#79, the same for the mods'
site.

Checked by building the docs locally with MkDocs 1.6: the 82
descriptions are all different, 80 to 159 characters, and the sitemap's
dates match git.

This branch has not been deployed

No deployments
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.

1 participant