docs social cards and cleanup (#47)

Author: samuelcolvin

.github/workflows/ci.yml

@@ -54,7 +54,7 @@ jobs:
         env:
           PPPR_TOKEN: ${{ secrets.PPPR_TOKEN }}
 
-      - run: uv pip freeze
+      - run: tree site
 
   test:
     name: test on ${{ matrix.python-version }}

.gitignore

@@ -11,4 +11,5 @@ env*/
 /postgres-data/
 .DS_Store
 /pydantic_ai_examples/.chat_app_messages.jsonl
+.cache/
 .docs-insiders-install

Makefile

@@ -85,13 +85,13 @@ docs-serve-insiders: .docs-insiders-install
 .PHONY: cf-pages-build  # Install uv, install dependencies and build the docs, used on CloudFlare Pages
 cf-pages-build:
 	curl -LsSf https://astral.sh/uv/install.sh | sh
-	${HOME}/.local/bin/uv python install 3.12
-	${HOME}/.local/bin/uv sync --python 3.12 --frozen --group docs
-	${HOME}/.local/bin/uv pip install -U \
+	uv python install 3.12
+	uv sync --python 3.12 --frozen --group docs
+	uv pip install -U \
 		--extra-index-url https://pydantic:$(PPPR_TOKEN)@pppr.pydantic.dev/simple/ \
 		mkdocs-material mkdocstrings-python
-	${HOME}/.local/bin/uv pip freeze
-	${HOME}/.local/bin/uv run --no-sync mkdocs build
+	uv pip freeze
+	uv run --no-sync mkdocs build
 
 .PHONY: all
 all: format lint typecheck testcov

docs/examples/index.md

@@ -49,8 +49,6 @@ Then set the API key as an environment variable with:
 
 ### Running Examples
 
-These examples are distributed with the `pydantic-ai` package so you can run them either by cloning the [pydantic-ai repo](https://github.com/pydantic/pydantic-ai) or by simply installing `pydantic-ai` from PyPI with `pip` or `uv`.
-
 To run the examples (this will work whether you installed `pydantic_ai`, or cloned the repo), run:
 
 ```bash

docs/examples/stream-markdown.md

@@ -4,6 +4,8 @@ hide: [toc]
 
 This example shows how to stream markdown from an agent, using the [`rich`](https://github.com/Textualize/rich) library to highlight the output in the terminal.
 
+It'll run the example with both OpenAI and Google Gemini models if the required environment variables are set.
+
 Demonstrates:
 
 * streaming text responses

docs/examples/weather-agent.md

@@ -16,16 +16,15 @@ the `get_weather` tool to get the weather for those locations.
 
 ## Running the Example
 
-To run this example properly, you'll need two extra API keys:
+To run this example properly, you might want to add two extra API keys **(Note if either key is missing, the code will fall back to dummy data, so they're not required)**:
+
 * A weather API key from [tomorrow.io](https://www.tomorrow.io/weather-api/) set via `WEATHER_API_KEY`
 * A geocoding API key from [geocode.maps.co](https://geocode.maps.co/) set via `GEO_API_KEY`
 
-**(Note if either key is missing, the code will fall back to dummy data.)**
-
 With [dependencies installed and environment variables set](./index.md#usage), run:
 
 ```bash
-python/uv-run -m pydantic_ai_examples.pydantic_model
+python/uv-run -m pydantic_ai_examples.weather_agent
 ```
 
 ## Example Code

docs/index.md

@@ -1,8 +1,8 @@
 <p align="center">
-  <img src="./img/pydantic-ai-dark.svg#only-dark" alt="PydanticAI">
+  <img src="./img/pydantic-ai-dark.svg#only-dark" alt="PydanticAI" style="max-width: 600px">
 </p>
 <p align="center">
-  <img src="./img/pydantic-ai-light.svg#only-light" alt="PydanticAI">
+  <img src="./img/pydantic-ai-light.svg#only-light" alt="PydanticAI" style="max-width: 600px">
 </p>
 <p align="center">
   <em>Agent Framework / shim to use Pydantic with LLMs</em>

mkdocs.yml

@@ -135,6 +135,7 @@ watch:
 
 plugins:
   - search
+  - social
   - mkdocstrings:
       handlers:
         python:

pyproject.toml

@@ -70,7 +70,7 @@ dev = [
 ]
 docs = [
     "mkdocs",
-    "mkdocs-material",
+    "mkdocs-material[imaging]",
     "mkdocstrings-python",
 ]