-
Notifications
You must be signed in to change notification settings - Fork 957
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add meta titles and descriptions to guides #10418
Comments
It'd be helpful if you gave some references to the guide the ideal content here. |
More examples: diff --git a/docs/guides/integration/fastapi.md b/docs/guides/integration/fastapi.md
index 654b2ed14..6693f46d3 100644
--- a/docs/guides/integration/fastapi.md
+++ b/docs/guides/integration/fastapi.md
@@ -1,3 +1,10 @@
+---
+title: Using uv with FastAPI
+description:
+ A guide to using uv with FastAPI to manage Python dependencies, run applications, and deploy with
+ Docker.
+---
+
# Using uv with FastAPI
[FastAPI](https://github.com/fastapi/fastapi) is a modern, high-performance Python web framework.
diff --git a/docs/guides/integration/jupyter.md b/docs/guides/integration/jupyter.md
index 358a090d4..f1292a581 100644
--- a/docs/guides/integration/jupyter.md
+++ b/docs/guides/integration/jupyter.md
@@ -1,3 +1,10 @@
+---
+title: Using uv with Jupyter
+description:
+ A complete guide to using uv with Jupyter notebooks for interactive computing, data analysis, and
+ visualization, including kernel management and virtual environment integration.
+---
+
# Using uv with Jupyter
The [Jupyter](https://jupyter.org/) notebook is a popular tool for interactive computing, data
diff --git a/docs/guides/integration/pre-commit.md b/docs/guides/integration/pre-commit.md
index 6d963f8a4..e60c17854 100644
--- a/docs/guides/integration/pre-commit.md
+++ b/docs/guides/integration/pre-commit.md
@@ -1,3 +1,10 @@
+---
+title: Using uv with pre-commit
+description:
+ A guide to using uv with pre-commit to automatically update lock files, export requirements, and
+ compile requirements files.
+---
+
# Using uv in pre-commit
An official pre-commit hook is provided at |
I PR'd those here: #10421 |
I'd like to know why you decided to add meta titles. Who is the target audience for these? LLMs should be pretty good at summarizing. I think having them create meta titles for each document and then just tweaking them a bit should be enough. |
This is primarily for SEO. Adding a meta-description can help with ranking, and they appear in the search engine results pages (SERPs). I did generate the above with prompting + some manual tweaks. |
I'll wrap these up. |
We should probably do this everywhere, but the guides would be a good start.
The text was updated successfully, but these errors were encountered: