Skip to content

Commit 4cf3f90

Browse files
Auto-update documentation (#19109)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Alex Streed <[email protected]>
1 parent 7c7b00a commit 4cf3f90

File tree

8 files changed

+21
-6
lines changed

8 files changed

+21
-6
lines changed

docs/docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2418,4 +2418,4 @@
24182418
}
24192419
],
24202420
"theme": "mint"
2421-
}
2421+
}

docs/v3/examples/index.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,25 @@ Have an example to share? Check out our [contributing guide](/contribute/docs-co
1515
<Card title="Hello, world!" icon="play" href="/v3/examples/hello-world">
1616
Your first steps with Prefect – learn how to create a basic flow and understand core concepts.
1717
</Card>
18-
18+
1919

2020
<Card title="API-sourced ETL" icon="database" href="/v3/examples/run-api-sourced-etl">
2121
Build a small ETL pipeline that fetches JSON from a public API, transforms it with pandas, and writes a CSV – all orchestrated by Prefect.
2222
</Card>
23-
23+
2424

2525
<Card title="dbt Model Orchestration" icon="database" href="/v3/examples/run-dbt-with-prefect">
2626
Orchestrate any dbt project with bullet-proof retries, observability, and a single Python file – no YAML or shell scripts required.
2727
</Card>
28-
28+
2929

3030
<Card title="Social Analytics Dashboard" icon="chart-bar" href="/v3/examples/atproto-dashboard-with-prefect-assets">
3131
Build a social media analytics dashboard using Prefect Assets, ATProto/Bluesky APIs, dbt transformations, and Streamlit visualization.
3232
</Card>
33-
33+
3434

3535
<Card title="Simple web scraper" icon="globe" href="/v3/examples/simple-web-scraper">
3636
Learn how to scrape article content from web pages with Prefect tasks, retries, and automatic logging.
3737
</Card>
38-
38+
3939
</CardGroup>

examples/atproto_dashboard_with_prefect_assets.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
# tags: [assets, social-media, analytics, dbt, streamlit, atproto, bluesky]
88
# github_url: https://github.com/zzstoatzz/atproto-dashboard
99
# draft: false
10+
# order: 4
1011
# ---
1112
#
1213
# **Build data pipelines with Prefect Assets – declarative, dependency-aware, and observable.**

examples/hello_world.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
# dependencies: ["prefect"]
66
# keywords: ["getting_started", "basics"]
77
# draft: false
8+
# order: 1
89
# ---
910
#
1011
# Welcome to your first Prefect flow. In under a minute you will:

examples/run_api_sourced_etl.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
# dependencies: ["prefect", "httpx", "pandas"]
66
# keywords: ["getting_started", "etl", "pandas"]
77
# draft: false
8+
# order: 2
89
# ---
910
#
1011
# Prefect turns everyday Python into production-grade workflows with **zero boilerplate**.

examples/run_dbt_with_prefect.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
# dependencies: ["prefect", "prefect-dbt>=0.7.0rc1", "dbt-core", "dbt-duckdb"]
66
# keywords: ["dbt", "materialization", "tasks", "analytics"]
77
# draft: false
8+
# order: 3
89
# ---
910
#
1011
# **Transform unreliable dbt scripts into production-grade data pipelines with enterprise observability, automatic failure recovery, and zero-downtime deployments.**

examples/simple_web_scraper.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
# dependencies: ["prefect", "requests", "beautifulsoup4"]
66
# keywords: ["getting_started", "webscraping", "tasks", "retries"]
77
# draft: false
8+
# order: 5
89
# ---
910
#
1011
# This example shows how Prefect enhances regular Python code without getting in its way.

scripts/generate_example_pages.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,15 @@ class Example:
2828
description: str
2929
icon: str
3030
keywords: list[str]
31+
order: int | None = None
3132

3233

3334
class Frontmatter(TypedDict, total=False):
3435
title: str
3536
description: str
3637
icon: str
3738
keywords: list[str]
39+
order: int
3840

3941

4042
async def get_examples() -> list[Example]:
@@ -52,8 +54,16 @@ async def get_examples() -> list[Example]:
5254
description=example_frontmatter.get("description", ""),
5355
icon=example_frontmatter.get("icon", ""),
5456
keywords=example_frontmatter.get("keywords", []),
57+
order=example_frontmatter.get("order"),
5558
)
5659
)
60+
# Sort examples by order field (if present), then by filename
61+
examples.sort(
62+
key=lambda ex: (
63+
ex.order if ex.order is not None else float("inf"),
64+
ex.path.name,
65+
)
66+
)
5767
return examples
5868

5969

0 commit comments

Comments
 (0)