docs: add project logo and GitHub social preview header - #2
Merged
Conversation
Add an original mark for jirakeep under assets/ and show it in the README. The design is a deliberate sibling of the bugwarden logo, matching the project's declared relationship: same slate shield and amber subject on white, same palette (#D89327 amber, #56656F slate). Inside the shield stands a keep -- the fortified tower the name promises -- whose gateway is a keyhole: access decided at the door, which is what the policy guard does. The mark stays legible down to 48px. The README references the logo by absolute raw.githubusercontent URL so it also renders on crates.io, where relative links do not resolve. assets/social-header.png is sized 1280x640 for GitHub's Settings -> Social preview and mirrors bugwarden's header layout (cream ground, slate wordmark, amber rule). SVGs carry an SPDX Apache-2.0 header matching the crate licence.
plusky
force-pushed
the
docs/project-logo
branch
from
August 8, 2026 18:17
796d514 to
8b8dc59
Compare
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.
Adds an original logo for jirakeep under
assets/and shows it in the READMEnext to the title.
The design
A deliberate sibling of the bugwarden
mark, matching the relationship the README declares: same slate shield and
amber subject on white, same palette (amber
#D89327, slate#56656F), sameassets/layout and cream social-header dialect.Inside the shield stands a keep — the fortified tower the name promises —
and its gateway is a keyhole: access decided at the door, which is exactly
what the policy guard does. Chosen from five candidate directions judged at
320/128/48px; a literal portcullis drawing of the same idea dissolved into
noise at small sizes, the keyhole gate survives at 48px.
Files
assets/logo.svgassets/social-header.svgassets/social-header.pngThe PNG must be uploaded once by hand in the repo settings — GitHub does not
read it from the tree.
The README references the logo by absolute
raw.githubusercontentURL soit also renders on crates.io, where relative links do not resolve. Consequence:
the image 404s in this PR's own diff preview, because the URL points at
mainand the file does not exist there until this merges.
Both SVGs carry an
SPDX-License-Identifier: Apache-2.0header matching thecrate licence. The artwork is original, drawn by hand as plain SVG primitives;
no third-party asset, font outline or generator output is embedded.
Verification
Ran the AGENTS.md gate locally, all green:
cargo fmt --check— passcargo clippy --workspace --all-targets -- -D warnings— passcargo clippy -p jirakeep --features gen --all-targets -- -D warnings— passcargo test --workspace --all-targets --locked— pass, 42 tests, 0 failedNot run:
cargo deny check— cargo-deny is not installed here; this changeadds no dependencies and touches no manifest, and CI runs it regardless.