Skip to content

Commit a8e491c

Browse files
lesnik512claude
andauthored
docs(profile): drop the type badge column from the templates table (#44)
The static `type: template` chip said nothing the "Project templates" heading did not, and existed only to fill the slot where the other tables put Downloads. The templates table is now `Project | What it is | Stars`. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 128916a commit a8e491c

3 files changed

Lines changed: 44 additions & 9 deletions

File tree

architecture/org-profile.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,16 @@ frontmatter; dated by git.
2020
pyproject `description`, and this blurb). The three published-library
2121
tables (DI, microservices, utilities) share the shape
2222
`Project | What it is | Stars | Downloads`; the templates table is
23-
`Project | What it is | Stars | Badges`.
23+
`Project | What it is | Stars`.
2424

2525
## Badge rules
2626

2727
- **Published libraries** get a Stars shield → stargazers, and a monthly
2828
Downloads shield (`static.pepy.tech/badge/<pkg>/month`) → the pepy project
2929
page.
30-
- **Templates** (`*-sqlalchemy-template`, not on PyPI) get a Stars shield and,
31-
in their Badges cell, only a static `type: template` chip — templates have
32-
no Downloads column, hence that column keeps the generic "Badges" header
33-
instead of "Downloads".
30+
- **Templates** (`*-sqlalchemy-template`, not on PyPI) get a Stars shield only —
31+
they have no Downloads column, and their table stops after Stars rather than
32+
carrying a filler chip.
3433
- All badges use flat (default) style so row heights align. Downloads use the
3534
pepy baked SVG, not the flaky shields `pypi/dm` endpoint. Every number is a
3635
live shield (no hand-typed stats that could go stale).
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
summary: Drop the static `type: template` chip and its Badges column from the profile templates table, leaving `Project | What it is | Stars`.
3+
---
4+
5+
# Change: Drop the type badge from the profile templates table
6+
7+
**Lane:** lightweight — docs-only, 2 files, no public-API change.
8+
9+
## Goal
10+
11+
The **Project templates** table in `profile/README.md` carried a fourth column
12+
holding a static `type: template` chip. It conveys nothing the section heading
13+
does not already say, and it exists only to fill the slot where the other three
14+
tables put Downloads. Remove the chip and the column.
15+
16+
## Approach
17+
18+
The templates table becomes `Project | What it is | Stars`. The published-library
19+
tables (DI, microservices, utilities) are untouched and keep their Downloads
20+
column — table shapes differing by category is fine, since each is read on its
21+
own. Promote the new shape into `architecture/org-profile.md`, which documented
22+
both the header name and the chip.
23+
24+
## Files
25+
26+
- `profile/README.md` — templates table: drop the `Badges` header, its separator
27+
cell, and the chip from both template rows.
28+
- `architecture/org-profile.md` — update the templates table shape and the badge
29+
rule that described the chip.
30+
31+
## Verification
32+
33+
- [ ] `just check-planning` — planning index clean.
34+
- [ ] `just test` — full suite green.
35+
- [ ] Templates table renders with three columns; no `type-template` shield URL
36+
remains anywhere in the repo.

profile/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ Open-source templates and libraries for building production-ready Python applica
1414

1515
### Project templates
1616

17-
| Project | What it is | Stars | Badges |
18-
|---|---|---|---|
19-
| [`fastapi-sqlalchemy-template`](https://github.com/modern-python/fastapi-sqlalchemy-template) | Dockerized FastAPI + SQLAlchemy 2 + PostgreSQL app template with DI | [![Stars](https://img.shields.io/github/stars/modern-python/fastapi-sqlalchemy-template)](https://github.com/modern-python/fastapi-sqlalchemy-template/stargazers) | ![Template](https://img.shields.io/badge/type-template-blue) |
20-
| [`litestar-sqlalchemy-template`](https://github.com/modern-python/litestar-sqlalchemy-template) | Dockerized Litestar + SQLAlchemy 2 + PostgreSQL app template with DI | [![Stars](https://img.shields.io/github/stars/modern-python/litestar-sqlalchemy-template)](https://github.com/modern-python/litestar-sqlalchemy-template/stargazers) | ![Template](https://img.shields.io/badge/type-template-blue) |
17+
| Project | What it is | Stars |
18+
|---|---|---|
19+
| [`fastapi-sqlalchemy-template`](https://github.com/modern-python/fastapi-sqlalchemy-template) | Dockerized FastAPI + SQLAlchemy 2 + PostgreSQL app template with DI | [![Stars](https://img.shields.io/github/stars/modern-python/fastapi-sqlalchemy-template)](https://github.com/modern-python/fastapi-sqlalchemy-template/stargazers) |
20+
| [`litestar-sqlalchemy-template`](https://github.com/modern-python/litestar-sqlalchemy-template) | Dockerized Litestar + SQLAlchemy 2 + PostgreSQL app template with DI | [![Stars](https://img.shields.io/github/stars/modern-python/litestar-sqlalchemy-template)](https://github.com/modern-python/litestar-sqlalchemy-template/stargazers) |
2121

2222
### Dependency injection
2323

0 commit comments

Comments
 (0)