Skip to content

Commit 9f17b50

Browse files
committed
Updated documentation for the sponsorship changes.
1 parent 892be30 commit 9f17b50

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ Weekly Dev Chat website — MkDocs Material static site. Read `mkdocs.yml` and r
1111
- Use `./create_post.sh` to scaffold a new post (calculates next Tuesday automatically).
1212
- **Multiple posts on the same date:** If a date folder already has an `index.md`, prefix the filename with a number and dash (e.g., `0-index.md`). The newest/latest post should use the lowest number so it appears first on the homepage. The original `index.md` keeps its name.
1313

14+
## Sponsors
15+
16+
- Sponsor data lives in `data/sponsors.yml` (loaded via the `mkdocs-macros` plugin). The file's header comment documents the schema and consent policy.
17+
- Sponsor logos go in `docs/assets/sponsors/`. Reference them with just the filename in the `image:` field.
18+
- Optimize logos with `python3 scripts/optimize_image.py <path>` before committing.
19+
- The page itself is `docs/sponsors/index.md`; styles are in `docs/stylesheets/sponsors.css`.
20+
1421
## Guardrails
1522

1623
- Pushing to `main` triggers automatic deployment to production. Do not push without explicit approval.

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ This script requires `pyyaml`, which is included in `requirements.txt`. It is al
175175

176176
## Updating Sponsors
177177

178-
Sponsor and donor entries live in [`data/sponsors.yml`](data/sponsors.yml), which is loaded into the sponsors page via the [`mkdocs-macros`](https://mkdocs-macros-plugin.readthedocs.io/) plugin. The file's header comment documents the schema, consent policy, and how to reference one sponsor across multiple years. Place sponsor logos in `docs/sponsors/` and reference the filename via the `image:` field.
178+
Sponsor and donor entries live in [`data/sponsors.yml`](data/sponsors.yml), which is loaded into the sponsors page via the [`mkdocs-macros`](https://mkdocs-macros-plugin.readthedocs.io/) plugin. The file's header comment documents the schema, consent policy, and how to reference one sponsor across multiple years. Place sponsor logos in `docs/assets/sponsors/` and reference the filename via the `image:` field (e.g. `image: example.png``docs/assets/sponsors/example.png`). Optimize logos with `python3 scripts/optimize_image.py` before committing.
179179

180180
## Project Structure
181181

@@ -205,9 +205,10 @@ Sponsor and donor entries live in [`data/sponsors.yml`](data/sponsors.yml), whic
205205
├── tags.md # Tags index page (auto-populated by tags plugin)
206206
├── hosts/ # Current hosts
207207
├── past-hosts/ # Past hosts
208-
├── sponsors/ # Sponsors
208+
├── sponsors/ # Sponsors page (index.md)
209209
├── posts/ # Blog posts (YYYY/MM/DD/)
210210
├── assets/ # Images, logos
211+
│ └── sponsors/ # Sponsor logos (referenced by data/sponsors.yml)
211212
└── stylesheets/
212213
├── extra.css # Site-wide custom CSS
213214
└── sponsors.css # Sponsors page styling

0 commit comments

Comments
 (0)