Skip to content

docs: use the StackGuardian icon as the site logo - #277

Closed
refeed wants to merge 1 commit into
mainfrom
docs/sg-logo
Closed

docs: use the StackGuardian icon as the site logo#277
refeed wants to merge 1 commit into
mainfrom
docs/sg-logo

Conversation

@refeed

@refeed refeed commented Aug 13, 2026

Copy link
Copy Markdown
Member

Swaps the navbar logo for the StackGuardian mark. That logo is what sits top-left on the landing page and on every documentation page, so it is the one visible on https://stackguardian.github.io/tirith/.

  logo: {
-   alt: 'Tirith Logo',
-   src: 'img/tirith.png',
+   alt: 'StackGuardian logo',
+   src: 'img/sg-icon.png',
  },

The asset is added at documentation/static/img/sg-icon.png — 512×512 PNG, RGBA, 17.7 KB.

The alt text changes with it. It read "Tirith Logo", and the image is now the StackGuardian mark, so leaving it would have a screen reader announce the wrong name for the image.

Verified

npm run build passes, and the built output references the new asset rather than resolving to a 404:

<img src="/tirith/img/sg-icon.png" alt="StackGuardian logo" class="… themedComponent--light_NVdE">
<img src="/tirith/img/sg-icon.png" alt="StackGuardian logo" class="… themedComponent--dark_xIcU">

Both the light and dark variants pick it up — Docusaurus emits two <img> elements for a themed logo, and a change that only landed on one would look correct until someone toggled the theme. build/img/sg-icon.png is emitted.

Not changed: the favicon

favicon: 'img/tirith.png' is untouched, and img/tirith.png is now used for nothing else. That is deliberate rather than an oversight: the favicon is how the site is identified in a tab strip, in history and in bookmarks, which is a separate decision from the in-page logo. Say the word and it is a one-line follow-up — or the old asset can be deleted at the same time.

Replaces img/tirith.png in the navbar with the StackGuardian mark, which is
what appears top-left on the landing page and on every docs page.

The alt text changes with it: it said "Tirith Logo", and the image is now the
StackGuardian logo, so a screen reader would otherwise announce the wrong name.

The favicon still points at img/tirith.png. Left deliberately -- swapping the
browser-tab icon changes how the site is identified in a tab strip and in
bookmarks, which is a separate call from the in-page logo.
Copilot AI lite review requested due to automatic review settings August 13, 2026 13:52

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 reached their quota limit.

@sonarqubecloud

Copy link
Copy Markdown

❌ The last analysis has failed.

See analysis details on SonarQube Cloud

@codecov

codecov Bot commented Aug 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@refeed

refeed commented Aug 13, 2026

Copy link
Copy Markdown
Member Author

Superseded by #279, which carries this commit unchanged alongside the button-colour change so the two land as one review.

@refeed refeed closed this Aug 13, 2026
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