Skip to content

Commit 52ebe3b

Browse files
authored
docs: sync social-card taglines with repo descriptions (#125)
- DOCS_REPOS taglines now equal the profile row descriptions, enforced by a test, and the seven docs-site cards are regenerated. - Escape the tagline in the card's aria-label; the semvertag description contains '&', which made the SVG invalid. - modern-di-pytest profile row and docs index drop the em dash, matching the new pyproject description.
1 parent bb5563e commit 52ebe3b

18 files changed

Lines changed: 31 additions & 17 deletions

File tree

‎brand/build/projects.py‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
from collections.abc import Callable
2+
from html import escape
23
from pathlib import Path
34

45
from brand.build import geometry as g
@@ -165,13 +166,13 @@ def wrap_text(text: str, size: float, max_w: float) -> list[str]:
165166

166167

167168
DOCS_REPOS: dict[str, str] = {
168-
"modern-di": "powerful DI framework with scopes",
169-
"that-depends": "predecessor DI framework, still actively maintained",
170-
"lite-bootstrap": "lightweight package for bootstrapping new microservices",
171-
"httpware": "HTTP client framework with sync/async clients, middleware chain, and built-in resilience (retry, bulkhead)",
172-
"faststream-redis-timers": "FastStream broker integration for Redis-backed distributed timer scheduling",
173-
"faststream-outbox": "FastStream broker integration for the transactional outbox pattern with Postgres",
174-
"semvertag": "auto-tag your GitHub/GitLab repo with semantic version tags from CI",
169+
"modern-di": "Powerful dependency-injection framework with IoC container and scopes",
170+
"that-depends": "Simple, typed dependency-injection framework for Python",
171+
"lite-bootstrap": "Lightweight bootstrap for production-ready Python microservices",
172+
"httpware": "Typed, resilient HTTP clients for Python, sync and async",
173+
"faststream-redis-timers": "FastStream integration for Redis-backed distributed timer scheduling",
174+
"faststream-outbox": "FastStream transactional-outbox integration backed by a Postgres table",
175+
"semvertag": "Auto-tag GitHub & GitLab repos with semantic version tags from CI",
175176
}
176177

177178
_CARD_W = 1280
@@ -228,6 +229,6 @@ def project_social_card(repo: str, *, tagline: str) -> str:
228229
)
229230
return (
230231
f'<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 {_CARD_W} {_CARD_H}" '
231-
f'role="img" aria-label="{repo} — {tagline}">'
232+
f'role="img" aria-label="{repo}: {escape(tagline)}">'
232233
f"{panels}{mark}{name_svg}{tag_svg}{url_svg}</svg>"
233234
)
-201 Bytes
Loading

‎brand/projects/faststream-outbox/social-card.svg‎

Lines changed: 1 addition & 1 deletion
Loading
-292 Bytes
Loading

‎brand/projects/faststream-redis-timers/social-card.svg‎

Lines changed: 1 addition & 1 deletion
Loading
-2.92 KB
Loading

‎brand/projects/httpware/social-card.svg‎

Lines changed: 1 addition & 1 deletion
Loading
190 Bytes
Loading

‎brand/projects/lite-bootstrap/social-card.svg‎

Lines changed: 1 addition & 1 deletion
Loading
2.31 KB
Loading

0 commit comments

Comments
 (0)