docs: ASCII-only punctuation + Rayforce logo in README#10
Merged
singaraiona merged 1 commit intomainfrom May 1, 2026
Merged
Conversation
Two changes to README: 1. Replace every em-dash and en-dash with the plain hyphen, keeping the prose readable by re-flowing into commas, parentheses, or colons where a single hyphen would be awkward. House style is now ASCII-only punctuation (-, ', ") in all written output. 2. Add the Rayforce logo at the head of the "Built on Rayforce" section, theme-aware via <picture> with media query: light SVG for dark mode, dark SVG for light mode. Linked to upstream raw URLs so the logo always tracks rayforce/master without raysense needing to vendor a copy. No content changes beyond punctuation and the logo block.
4 tasks
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>
singaraiona
added a commit
that referenced
this pull request
May 1, 2026
Two changes to README: 1. Replace every em-dash and en-dash with the plain hyphen, keeping the prose readable by re-flowing into commas, parentheses, or colons where a single hyphen would be awkward. House style is now ASCII-only punctuation (-, ', ") in all written output. 2. Add the Rayforce logo at the head of the "Built on Rayforce" section, theme-aware via <picture> with media query: light SVG for dark mode, dark SVG for light mode. Linked to upstream raw URLs so the logo always tracks rayforce/master without raysense needing to vendor a copy. No content changes beyond punctuation and the logo block. Co-authored-by: Anton <anton.kundenko@gmail.com>
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two README polish items in one slice.
1. ASCII-only punctuation (house style)
Replaced every em-dash and en-dash with the plain hyphen
-. Where a single hyphen would have read awkwardly, re-flowed the sentence into commas, parentheses, or colons. No content meaning changed.Counts before, all zero after:
This rule applies to all future written output (prose, comments, commit messages, PR bodies, docstrings) and is now in my persistent memory.
2. Rayforce logo in the "Built on Rayforce" section
Added a theme-aware logo block:
Linked to upstream raw URLs (
raw.githubusercontent.com/RayforceDB/rayforce/master/docs/), so the logo always tracks rayforce/master with no copy to keep in sync. Light mode shows the dark logo, dark mode shows the light one.Test plan