Skip to content

Commit bb5563e

Browse files
authored
docs: fix drifted facts in the org profile, site, and contributor docs (#124)
- Delete brand/STORY.md and brand/story-assets/ (nothing else referenced them) - Use each repo's pyproject description for every row in profile/README.md and docs/index.md (httpware, templates, DI, services, utilities) - Add chat-app to the profile, site catalog, project marks, and site link check - CONTRIBUTING: point to just lint-ci / just lint, drop the "where a justfile exists" clause, say that-depends is the repo that runs mypy and pyrefly - brand/README: describe the chevron icon, drop the done header-logo follow-up - Reword the that-depends and migration-guide lines and the standard.md opener
1 parent 96cc5c0 commit bb5563e

23 files changed

Lines changed: 54 additions & 155 deletions

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ build backend, and a `justfile` with fixed recipe names as the only task entry p
2121
```bash
2222
# Clone your fork, then from the repo root:
2323
uv sync # install dependencies into a local venv
24-
just --list # see available tasks (lint, test, etc.) where a justfile exists
24+
just --list # see available tasks (lint, test, etc.)
2525
```
2626

2727
## Pull request workflow
@@ -30,10 +30,11 @@ just --list # see available tasks (lint, test, etc.) where a justfil
3030
2. Make your change. Keep it focused — one logical change per PR.
3131
3. Run lint, type check, and tests locally before pushing:
3232
```bash
33-
uv run ruff check . && uv run ruff format --check .
34-
uv run ty check # type check, where ty is configured (some repos also run mypy/pyrefly)
35-
# run the project's test command (often `just test` or `uv run pytest`)
33+
just lint-ci # read-only lint, format, and type checks
34+
just test
3635
```
36+
`just lint` runs the same checks and applies fixes. The templates and `chat-app` have
37+
only `just lint`. `that-depends` also runs mypy and pyrefly in both recipes.
3738
4. Update docs if you changed behavior or public API.
3839
5. Open the PR using the template. Link the issue it resolves.
3940

‎brand/README.md‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@ Without it the SVGs are still written and PNGs are skipped.
2222

2323
## Mark
2424

25-
Two interlocked "snakes" (corner brackets with square heads) as a pinwheel. The
26-
**icon** wraps them around a gold core dot (favicon + avatar). The **wordmark
25+
Two "snakes" (corner brackets with square heads and diagonal-cut tails), one
26+
ink and one gold, in opposite corners. The **icon** frames a gold chevron
27+
between them (favicon, avatar, and the site header logo). The **wordmark
2728
lockup** pulls them into crop marks framing `MODERN` / `PYTHON` set in **Jost**
2829
(SIL OFL, outlined to paths at build time — see `brand/build/fonts/Jost-OFL.txt`).
2930

@@ -70,7 +71,3 @@ FASTOCTREE) — indexed-colour, with no visible change (the art is flat-colour).
7071
The large assets (social cards, 1024px marks) shrink ~70–80% vs raw
7172
`rsvg-convert` output; the tiny favicons less. Regenerate with
7273
`uv run python -m brand.build.render`.
73-
74-
## Deferred (not in this kit)
75-
76-
The header nav logo redesign is a follow-up.

‎brand/STORY.md‎

Lines changed: 0 additions & 98 deletions
This file was deleted.

‎brand/build/projects.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,10 @@
3131
"modern-di-starlette": lambda: sym.sparkle_cluster(_CX, _CY, R),
3232
"modern-di-taskiq": lambda: sym.task_q(_CX, _CY, R),
3333
"modern-di-typer": lambda: sym.terminal(_CX, _CY, R),
34-
# templates — reuse the org chevron
34+
# templates and the reference app reuse the org chevron
3535
"fastapi-sqlalchemy-template": lambda: sym.chevron(_CX, _CY, R - 1),
3636
"litestar-sqlalchemy-template": lambda: sym.chevron(_CX, _CY, R - 1),
37+
"chat-app": lambda: sym.chevron(_CX, _CY, R - 1),
3738
# microservices, http & messaging
3839
"lite-bootstrap": lambda: sym.rocket(_CX, _CY, R),
3940
"httpware": lambda: sym.chain(_CX, _CY, R),
Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading

‎brand/projects/chat-app/lockup.png‎

1.33 KB
Loading
6.77 KB
Loading
2.81 KB
Loading

‎brand/projects/chat-app/mark.svg‎

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)