Skip to content

docs: refresh illustrated project branding - #462

Merged
btravers merged 5 commits into
mainfrom
codex/refresh-project-brand
Oct 7, 2026
Merged

btravers merged 5 commits into
mainfrom
codex/refresh-project-brand

Conversation

@btravers

@btravers btravers commented Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator

Preserve the illustrated btravstack mascot direction for temporal-contract: a small, cute rounded leafless beet resting at the bottom of an hourglass, with pink flow and drops continuing above, coordinated with the original framework illustration. Apply this family across the README, documentation navigation and hero, favicon, decorative backdrop, and social previews.

Ships local illustrated light/dark variants, a grayscale illustration, favicon, and 1200 × 630 social-card assets. The README selects light/dark variants, and branding provenance points to the canonical editable sources. Existing version-aware deployment paths and release configuration are preserved.

Validation:

  • Documentation build, generated stable asset URLs, and beta config URL checks.
  • Scoped formatting, repository lint, and git diff --check.
  • SVG XML, canonical asset equality, and social image dimensions.
  • Browser light/dark hero asset loading and desktop/mobile visual checks.

Builds emit the existing large-chunk notices; no runtime or integration tests were needed for this documentation-only change.

Security Audit is fixed by refreshing only shell-quote from 1.10.0 to 1.11.0 in the lockfile for @changesets/cli > launch-editor. This satisfies the existing ^1.8.4 parent range and fixes GHSA-pqg4-j6r4-53mv. Version 1.11.0 was published on 2026-09-29 and passes the unchanged seven-day strict release-age policy. Frozen install, pnpm audit --audit-level=high, and Changesets status pass locally; All CI jobs passed on the fix, including Security Audit and integration tests.

Summary by CodeRabbit

  • Documentation
    • Added branding guidance covering asset generation, placement, social cards, and documentation-site assets.
    • Updated the README logo’s alternative text and the homepage mascot description.
  • Style
    • Updated the documentation site to use a dedicated favicon and monochrome hero backdrop logo.
    • The README logo now adapts to light and dark color schemes, with the existing logo retained as a fallback.

Copilot AI balanced review requested due to automatic review settings October 6, 2026 23:50
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-07T08:27:03.132956Z e5ee042 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: btravstack/temporal-contract/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 39c48364-c036-483f-baf8-945da20b2be2
📥 Commits

Reviewing files that changed from the base of the PR and between a82d01a and c265679.

⛔ Files ignored due to path filters (7)
  • docs/public/favicon.svg is excluded by !**/*.svg
  • docs/public/logo-dark.svg is excluded by !**/*.svg
  • docs/public/logo-light.svg is excluded by !**/*.svg
  • docs/public/logo-mono.svg is excluded by !**/*.svg
  • docs/public/logo.svg is excluded by !**/*.svg
  • docs/public/og-temporal-contract.png is excluded by !**/*.png
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml, !pnpm-lock.yaml
📒 Files selected for processing (3)
  • README.md
  • docs/branding/README.md
  • docs/index.md
🚧 Files skipped from review as they are similar to previous changes (3)
  • docs/index.md
  • docs/branding/README.md
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README and documentation site now use updated logo variants and alt text. The site favicon points to favicon.svg. The branding README describes logo assets, social-card rendering, and deployment-base handling.

Changes

Documentation branding

Layer / File(s) Summary
Logo display
README.md, docs/.vitepress/theme/custom.css, docs/index.md
The README selects light- or dark-scheme logo SVGs and retains the existing image as a fallback. The documentation home page uses updated hero image alt text. The hero mask uses /logo-mono.svg.
Favicon and branding guidance
docs/.vitepress/config.ts, docs/branding/README.md
The favicon URL now points to favicon.svg. The branding README describes logo assets, social-card rendering, mark selection, and deployment-base handling.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to c2656

The branding assets appear to resolve correctly on the documented deployment paths. The change is ready for normal merge checks.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely describes the illustrated branding refresh, which is the main change.
Description check ✅ Passed The description gives a detailed summary and validation results. It does not include the template’s Checklist section or state whether a changeset and documentation updates are needed, but the descrip…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d38973e15e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/.vitepress/config.ts

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

It is a self-contained documentation/asset refresh where all SVGs are valid, asset references resolve under the deployment base, the og image is 1200×630, and logo.svg matches logo-light.svg as documented.

Review effort: Balanced
Findings: None

What changed in this PR

This PR refreshes the public branding/identity of temporal-contract with the new btravstack family mark. It is a documentation- and asset-only change: no source code, runtime behavior, or release configuration is modified. The new marks replace the previous hourglass/beet motif across the README, docs hero, favicon, and decorative hero backdrop, and adds a branding provenance doc so the assets can be regenerated from the canonical website generator.

Changes:

  • Swap all logo SVGs (light/dark/mono/fallback) and the favicon for the new mark, and add light/dark variant selection to the README via <picture>.
  • Point the docs head favicon link at the dedicated favicon.svg and the hero backdrop mask at the local /logo-mono.svg (replacing the inline base64 clock motif).
  • Add docs/branding/README.md documenting asset provenance and the refresh procedure, plus alt-text clarification in docs/index.md.
File Description
README.md Adds a <picture> block selecting light/dark logo variants with an accessible fallback <img>.
docs/​public/​logo.svg Replaces the fallback mark; kept byte-identical to logo-light.svg (verified).
docs/​public/​logo-light.svg New light-mode mark.
docs/​public/​logo-dark.svg New dark-mode mark with dark-scheme colors.
docs/​public/​logo-mono.svg New monochrome mark used as the hero backdrop silhouette.
docs/​public/​favicon.svg New compact favicon mark (heavier stroke for small sizes).
docs/​index.md Clarifies hero image alt text to "temporal-contract logo".
docs/​branding/​README.md New provenance/refresh documentation for brand assets.
docs/​.vitepress/​theme/​custom.css Replaces inline base64 mask with /logo-mono.svg; Vite rebases this public URL with the deployment base.
docs/​.vitepress/​config.ts Favicon head link now uses ${BASE}favicon.svg, consistent with base-aware URL handling.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@btravers btravers changed the title docs: refresh project branding docs: refresh illustrated project branding Oct 7, 2026
@btravers
btravers merged commit a64b314 into main Oct 7, 2026
14 checks passed
@btravers
btravers deleted the codex/refresh-project-brand branch October 7, 2026 08:47
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