Skip to content

docs: vendor Rayforce logos in-tree, explicit picture sources#11

Merged
singaraiona merged 1 commit into
mainfrom
docs/in-tree-logos
May 1, 2026
Merged

docs: vendor Rayforce logos in-tree, explicit picture sources#11
singaraiona merged 1 commit into
mainfrom
docs/in-tree-logos

Conversation

@singaraiona
Copy link
Copy Markdown
Contributor

Why this exists

PR #10 merged before two follow-up commits landed on its branch, so the intended end state for the logo never reached main. This PR brings it over cleanly.

What changes

  1. Logos copied into docs/ (logo-dark.svg, logo-light.svg) from ../rayforce/docs/. Both projects share an author, so no license/attribution issue. raysense is now self-contained for README assets.

  2. README references them via relative path. Works on GitHub README, GitHub PR preview, and (because of Release 1.0.0 #4 below) crates.io.

  3. <picture> declares both light and dark sources explicitly. The prior single-source-plus-fallback was correct on github.com but fragile on other markdown renderers. Mapping is:

    Theme Source file Color
    Dark GH docs/logo-light.svg white mark on orange (visible on dark bg)
    Light GH docs/logo-dark.svg navy mark on orange (visible on light bg)
  4. Cargo.toml include adds docs/*.svg so the published .crate ships the SVGs and the relative paths render on crates.io too.

Verified

  • Local: README looks correct in both light and dark theme via GitHub web preview.
  • cargo package --list includes both SVGs.

Test plan

  • Render the README on GitHub in both light and dark themes; confirm the logo swaps appropriately.
  • After merge: pre-publish cargo package includes docs/logo-*.svg.

PR #10 merged before two follow-up commits landed; this brings the
intended end state onto main:

1. Logo files copied from ../rayforce/docs into raysense's own docs/.
   Both projects are owned by the same author, no attribution issue.
   raysense is now self-contained for README assets and no longer
   depends on rayforce/master staying public or stable.

2. README references them via relative path, which works in:
   - GitHub README rendering on main
   - GitHub PR preview on a feature branch
   - crates.io README rendering once `docs/*.svg` ships in the .crate

3. <picture> now declares both light and dark sources explicitly
   (the prior single-source-plus-fallback worked on github.com but
   was fragile on some other markdown renderers):

     dark theme  -> logo-light.svg (white mark, visible on dark bg)
     light theme -> logo-dark.svg  (navy mark,  visible on light bg)

4. Cargo.toml `include` whitelist updated with `docs/*.svg` so the
   published .crate ships the SVGs.
@singaraiona singaraiona merged commit 6c8b722 into main May 1, 2026
1 check passed
@singaraiona singaraiona deleted the docs/in-tree-logos branch May 1, 2026 15:44
singaraiona added a commit that referenced this pull request May 1, 2026
PR #10 merged before two follow-up commits landed; this brings the
intended end state onto main:

1. Logo files copied from ../rayforce/docs into raysense's own docs/.
   Both projects are owned by the same author, no attribution issue.
   raysense is now self-contained for README assets and no longer
   depends on rayforce/master staying public or stable.

2. README references them via relative path, which works in:
   - GitHub README rendering on main
   - GitHub PR preview on a feature branch
   - crates.io README rendering once `docs/*.svg` ships in the .crate

3. <picture> now declares both light and dark sources explicitly
   (the prior single-source-plus-fallback worked on github.com but
   was fragile on some other markdown renderers):

     dark theme  -> logo-light.svg (white mark, visible on dark bg)
     light theme -> logo-dark.svg  (navy mark,  visible on light bg)

4. Cargo.toml `include` whitelist updated with `docs/*.svg` so the
   published .crate ships the SVGs.

Co-authored-by: Anton <anton.kundenko@gmail.com>
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