You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 8c495c3
Browse filesBrowse the repository at this point in the historyBrowse files
docs: cut the glossary to terms the repo actually contests; drop the census
Auditing the ten terms against real usage found most of the _Avoid_ lists banning
words that have a legitimate independent meaning here, which would make the glossary
wrong to follow:
- `icon` is `geometry.icon()`, plus favicon and apple-touch-icon.
- `glyph` is what `text.py` means by it — an outlined character from the font.
- `theme` is the mkdocs config key; `variant` is the light/dark image pair and the
padded circular-crop mark; `title` is front matter; `header` is the site header and
Boosty's header slot; `banner` is the README banner.
- `logo` is right to reject for our own assets, but a third party's logo is a logo —
`symbols.py` draws from Flask's and FastStream's, and ADR 0004 is about exactly that.
- `logotype`, `combo mark`, `highlight` and `cutout` appear nowhere in the repo. A
synonym nobody has used is not a synonym to reject.
Three entries went the other way and were dropped as derivable: Brand kit (it is
`brand/`), Social card (`project_social_card` and the filenames), and the three
metadata surfaces, which restated the AGENTS.md section that owns them.
The audit did find one live split worth ruling on: `colourway` in prose, `colorway` in
two docstrings and the apparel README. British spelling wins for this one word, since
the assets and the docs describing them already read `colour`; the three sites are
corrected here so the glossary is true when it says so.
Ten terms become seven.
tests/test_invariant_census.py is removed on request. AGENTS.md now says plainly that
nothing enforces the INVARIANT: shape and nothing checks a cited ADR path, so both are
review-time reads — the ADR links in AGENTS.md and brand/README.md go back to failing
silently on a rename, which mkdocs --strict cannot see.
Verification: uv run pytest — 123 passed, 5 failed, 26 skipped; the five are the
pre-existing rsvg-convert failures. uv run mkdocs build --strict is clean.
0 commit comments