Skip to content

Add theme-aware OAR logo to README and documentation - #71

Merged
johnnygreco merged 3 commits into
mainfrom
johnny/oar-logo
Sep 11, 2026
Merged

Add theme-aware OAR logo to README and documentation#71
johnnygreco merged 3 commits into
mainfrom
johnny/oar-logo

Conversation

@johnnygreco

@johnnygreco johnnygreco commented Sep 11, 2026

Copy link
Copy Markdown
Collaborator

Add the NVIDIA-green OAR logo to the project README header and documentation landing page. The logo is a transparent SVG with an oar integrated into the A and a terminal prompt cutout in its blade.

Lettering adapts to light and dark mode. Documentation styling follows the site's theme toggle, including when it differs from the operating system's theme. The canonical asset lives in projects/openshell-agent-runner/assets/ and is copied into the documentation by the staging script. The README uses a relative image URL so it renders on the PR branch as well as main. The source distribution includes the asset. Asset-only changes also trigger documentation previews.

Validation:

  • make check: 153 tests passed, plus formatting, lint, type, compilation, and shell checks.
  • make build: source distribution and wheel built successfully.
  • python3 tests/test_render_dev_notes.py and scripts/build-docs.sh: passed.
  • Browser checks: both documentation themes with opposite OS preferences, exact logo colors, transparent background and letter openings, and mobile layout.
  • Seven documentation staging tests passed, including shared-asset copying and collision detection. Verified the staged logo matches the canonical asset and is included in the source distribution.

@github-actions

github-actions Bot commented Sep 11, 2026

Copy link
Copy Markdown

Documentation preview

The preview has been removed.

@johnnygreco
johnnygreco merged commit 21e28c9 into main Sep 11, 2026
19 checks passed
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