Skip to content

GitHub Pages website with SEO - #15

Merged
SushantGautam merged 1 commit into
mainfrom
site/github-pages
Nov 3, 2026
Merged

SushantGautam merged 1 commit into
mainfrom
site/github-pages

Conversation

@SushantGautam

Copy link
Copy Markdown
Collaborator

Adds a project website at https://simulamet.github.io/Verdi/ so search engines can find and list Verdi.

  • site/build.py builds a landing page plus four guide pages: sweeps, scenarios, researcher guide and institutional recovery. The guides are rendered from docs/*.md, so the site can't drift from the repo.
  • SEO on every page: a <title>, a meta description, a canonical URL, Open Graph and Twitter tags, and schema.org data (SoftwareSourceCode for the project, TechArticle for each guide). The site also has sitemap.xml and a robots.txt that points to it.
  • Layout: works on phones (no horizontal scrolling) and has a dark mode.
  • .github/workflows/pages.yml deploys the site when site/, docs/ or pyproject.toml change on main, or when run by hand.
  • The site link is now used in: the README (a link and a badge), the pyproject.toml Homepage and Documentation URLs (these show on PyPI from the next release), and the repo homepage setting.

Test plan

  • The site builds locally into 5 pages. I checked it in a browser at desktop and narrow widths, on the landing page and a guide page.
  • The internal links between guides resolve. Links to ../examples/... now point at their GitHub pages.
  • ruff passes.
  • The first deploy runs after merge.

site/build.py renders a landing page plus the guides (docs/*.md) into
_site/, each page with canonical URL, description, Open Graph and schema.org
data, plus sitemap.xml and robots.txt. pages.yml deploys it on changes to
main. README, pyproject URLs and the repo homepage point to
https://simulamet.github.io/Verdi/.
Copilot AI balanced review requested due to automatic review settings November 3, 2026 22:43

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

@SushantGautam
SushantGautam merged commit 095ecc7 into main Nov 3, 2026
1 check passed
@SushantGautam
SushantGautam deleted the site/github-pages branch November 3, 2026 22:50
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.

2 participants