From 973686890826bfb2eb822ade022d18127f04d2c5 Mon Sep 17 00:00:00 2001
From: FishAlchemist <48265002+FishAlchemist@users.noreply.github.com>
Date: Thu, 16 Jan 2025 04:12:55 +0800
Subject: [PATCH] Add meta titles to documents in guides, excluding integration
 documents. (#10539)

## Summary
Add meta titles to documents in guides, excluding integration documents.
<!-- What's the purpose of the change? What does it do, and why? -->

## Test Plan
``uvx --with-requirements docs/requirements.txt -- mkdocs build --strict
-f mkdocs.public.yml``
<details>
 <summary>Build Result</summary>

* ``guides/install-python``
```html
...
<meta name="description" content="Guide to install specific Python versions, manage existing installations, and automate downloads with uv.">
...
<title>Install and Manage Python | uv</title>
...
```
* ``guides/projects``
```html
...
<meta name="description" content="Guide to create, manage, and build Python projects with uv, including dependencies and distributions.">
...
<title>Working on projects | uv</title>
...
```
* ``guides/publish``
```html
...
<meta name="description" content="Guide to build and publish Python packages using uv">
...
<title>Publishing a package | uv</title>
...
```
* ``guides/scripts``
```html
...
<meta name="description" content="Run Python scripts quickly and manage dependencies efficiently using uv. Learn about inline metadata and more.">
...
<title>Run Scripts | uv</title>
...
```
* ``guides/tools``
```html
...
<meta name="description" content="Guide to run, install, and upgrade Python tools using uv.">
...
<title>Using tools | uv</title>
...
```
</details>

---------

Co-authored-by: Charles Tapley Hoyt <cthoyt@gmail.com>
Co-authored-by: Zanie Blue <contact@zanie.dev>
---
 docs/guides/install-python.md | 7 +++++++
 docs/guides/projects.md       | 7 +++++++
 docs/guides/publish.md        | 5 +++++
 docs/guides/scripts.md        | 7 +++++++
 docs/guides/tools.md          | 7 +++++++
 5 files changed, 33 insertions(+)

diff --git a/docs/guides/install-python.md b/docs/guides/install-python.md
index 9cefc830c..bc3555cdc 100644
--- a/docs/guides/install-python.md
+++ b/docs/guides/install-python.md
@@ -1,3 +1,10 @@
+---
+title: Installing and managing Python
+description:
+  A guide to using uv to install Python, including requesting specific versions, automatic
+  installation, viewing installed versions, and more.
+---
+
 # Installing Python
 
 If Python is already installed on your system, uv will
diff --git a/docs/guides/projects.md b/docs/guides/projects.md
index a9d219162..aff63e72b 100644
--- a/docs/guides/projects.md
+++ b/docs/guides/projects.md
@@ -1,3 +1,10 @@
+---
+title: Working on projects
+description:
+  A guide to using uv to create and manage Python projects, including adding dependencies, running
+  commands, and building publishable distributions.
+---
+
 # Working on projects
 
 uv supports managing Python projects, which define their dependencies in a `pyproject.toml` file.
diff --git a/docs/guides/publish.md b/docs/guides/publish.md
index d429ea26b..9e0fb114d 100644
--- a/docs/guides/publish.md
+++ b/docs/guides/publish.md
@@ -1,3 +1,8 @@
+---
+title: Publishing a package
+description: A guide to using uv to build and publish Python packages to a package index, like PyPI.
+---
+
 # Publishing a package
 
 uv supports building Python packages into source and binary distributions via `uv build` and
diff --git a/docs/guides/scripts.md b/docs/guides/scripts.md
index c6d10af63..1dbf91b3a 100644
--- a/docs/guides/scripts.md
+++ b/docs/guides/scripts.md
@@ -1,3 +1,10 @@
+---
+title: Running scripts
+description:
+  A guide to using uv to run Python scripts, including support for inline dependency metadata,
+  reproducible scripts, and more.
+---
+
 # Running scripts
 
 A Python script is a file intended for standalone execution, e.g., with `python <script>.py`. Using
diff --git a/docs/guides/tools.md b/docs/guides/tools.md
index e1419f0e6..9b128cdc0 100644
--- a/docs/guides/tools.md
+++ b/docs/guides/tools.md
@@ -1,3 +1,10 @@
+---
+title: Using tools
+description:
+  A guide to using uv to run tools published as Python packages, including one-off invocations with
+  uvx, requesting specific tool versions, installing tools, upgrading tools, and more.
+---
+
 # Using tools
 
 Many Python packages provide applications that can be used as tools. uv has specialized support for