Skip to content
This repository was archived by the owner on Oct 7, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/public/logo-dark.svg">
<img src="docs/public/logo-light.svg" alt="entity" width="170" height="114" />
<img src="docs/public/logo-light.svg" alt="entity logo" width="128" height="128" />
</picture>

# entity
Expand Down
14 changes: 4 additions & 10 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ export default defineConfig({
},

themeConfig: {
logo: { light: "/logo-light.svg", dark: "/logo-dark.svg" },
logo: { light: "/logo-light.svg", dark: "/logo-dark.svg", alt: "entity logo" },

nav: [
// The guide is organised by the four Diátaxis modes; the dropdown links
Expand Down Expand Up @@ -220,7 +220,7 @@ export default defineConfig({
},

head: [
["link", { rel: "icon", type: "image/svg+xml", href: `${BASE}logo.svg` }],
["link", { rel: "icon", type: "image/svg+xml", href: `${BASE}favicon.svg` }],
["meta", { name: "author", content: "Benoit TRAVERS" }],
["meta", { name: "robots", content: "index, follow" }],
["meta", { name: "application-name", content: "entity" }],
Expand All @@ -236,16 +236,10 @@ export default defineConfig({
["meta", { property: "og:type", content: "website" }],
["meta", { property: "og:site_name", content: "entity" }],
["meta", { property: "og:locale", content: "en_US" }],
// The 1280x640 social card, on the same template as the other btravstack
// packages. SVG is not a valid og:image: X, Slack, LinkedIn and Discord all
// refuse to render one, which is why pointing this at the logo produced no
// preview at all rather than a small one.
["meta", { property: "og:image", content: `${SITE_URL}og-entity.png` }],
["meta", { property: "og:image:type", content: "image/png" }],
// The card's true size. The sibling sites declare 1200x630 (the size the OG
// docs recommend) while shipping a 1280x640 file; these are measured.
["meta", { property: "og:image:width", content: "1280" }],
["meta", { property: "og:image:height", content: "640" }],
["meta", { property: "og:image:width", content: "1200" }],
["meta", { property: "og:image:height", content: "630" }],
[
"meta",
{
Expand Down
22 changes: 22 additions & 0 deletions docs/branding/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# entity branding

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Add a changeset for the public branding refresh

This commit changes the publicly deployed documentation branding, README logo, favicon, and social preview but includes no changeset, so it violates the repository's requirement that user-facing changes carry one and leaves the release tooling without a record of the update.

AGENTS.md reference: AGENTS.md:L340-L342

Useful? React with 👍 / 👎.


The illustrated mascot is a pink beet at the bottom of an identity-card photo,
with its hands resting across the lower frame as if ready to climb out. It belongs
to the shared btravstack beet family. Its editable source is
[`scripts/generate-brand.mjs`](https://github.com/btravstack/btravstack.github.io/blob/main/scripts/generate-brand.mjs)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Point branding source links at existing files

The two regeneration-source links introduced in this document currently return 404: the public website repository has neither the linked top-level scripts/generate-brand.mjs nor branding/social-card.html path. As a result, maintainers following these instructions cannot reach either editable source; update both links to their actual repository locations.

Useful? React with 👍 / 👎.

in the website repository. Regenerate there, then copy the project assets from
`apps/website/public/logos/` into this repository's `docs/public/`:

- `entity-light.svg` → `logo-light.svg` and `logo.svg` (the default).
- `entity-dark.svg` → `logo-dark.svg`.
- `entity-mono.svg` → `logo-mono.svg` (grayscale print, retaining the shading).
- `entity-favicon.svg` → `favicon.svg`.

The README and documentation navigation and hero use the light/dark pair.
The favicon uses a simplified mascot portrait for legibility at small sizes.
The social preview is `og-entity.png`, a 1200 × 630 PNG using the same mark.
Its editable source is the website's
[`branding/social-card.html`](https://github.com/btravstack/btravstack.github.io/blob/main/branding/social-card.html),
rendered with `?project=entity`.
Keep its dimensions in the VitePress metadata in sync when replacing it.
Assets are committed locally; rendering never fetches branding from another site.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ hero:
image:
light: /logo-light.svg
dark: /logo-dark.svg
alt: entity
alt: entity logo
actions:
- theme: brand
text: Get Started
Expand Down
17 changes: 17 additions & 0 deletions docs/public/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 17 additions & 33 deletions docs/public/logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading