Skip to content

Commit b74c365

Browse files
timsaucerclaude
andcommitted
docs: add llms.txt ecosystem hub at site root
Adds docs/source/llms.txt following the llmstxt.org schema as a directory hub for the DataFusion ecosystem: links to the core Rust user/library/ contributor guides, Rust API docs, and the Python/Ballista/Comet subproject docs roots. Configures Sphinx html_extra_path so the file is served verbatim at https://datafusion.apache.org/llms.txt, and excludes it from the RAT license-header check (markdown body cannot carry the standard "..." comment header). Per the convention noted in the file, agents can probe each subproject docs root for its own llms.txt — keeps the hub future-proof without hardcoding pending URLs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 9a29e33 commit b74c365

3 files changed

Lines changed: 31 additions & 0 deletions

File tree

dev/release/rat_exclude_files.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ datafusion/proto-common/src/generated/prost.rs
6060
.github/ISSUE_TEMPLATE/bug_report.yml
6161
.github/ISSUE_TEMPLATE/feature_request.yml
6262
.github/workflows/docs.yaml
63+
docs/source/llms.txt
6364
**/node_modules/*
6465
datafusion/wasmtest/pkg/*
6566
clippy.toml

docs/source/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,10 @@
109109
# so a file named "default.css" will overwrite the builtin "default.css".
110110
html_static_path = ["_static"]
111111

112+
# Copy agent-facing files (llms.txt) verbatim to the site root so they
113+
# resolve at the conventional URL `https://datafusion.apache.org/llms.txt`.
114+
html_extra_path = ["llms.txt"]
115+
112116
html_logo = "_static/images/2x_bgwhite_original.png"
113117

114118
html_css_files = ["theme_overrides.css"]

docs/source/llms.txt

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Apache DataFusion
2+
3+
> Apache DataFusion is an extensible query engine written in Rust that uses Apache Arrow as its in-memory format. This file is a directory of agent-facing entry points for the DataFusion ecosystem — the Rust core query engine and its subprojects. Subproject `llms.txt` files contain the project-specific guidance for writing code against each one.
4+
5+
## Core DataFusion (Rust)
6+
7+
- [User guide](https://datafusion.apache.org/user-guide/introduction.html): install, example usage, SQL, DataFrame, expressions, configuration, explain plans.
8+
- [Library user guide](https://datafusion.apache.org/library-user-guide/index.html): embedding DataFusion, extending SQL, custom table providers, building logical plans, the query optimizer.
9+
- [Contributor guide](https://datafusion.apache.org/contributor-guide/index.html): development environment, architecture, testing, release management, governance.
10+
- [Rust API docs (`docs.rs`)](https://docs.rs/datafusion/latest/datafusion/): generated reference for the `datafusion` crate.
11+
- [GitHub repository](https://github.com/apache/datafusion): source, issues, pull requests.
12+
13+
## Subprojects
14+
15+
Each subproject may expose its own `llms.txt` at `<docs root>/llms.txt` — agents following the [llmstxt.org](https://llmstxt.org) convention can probe these paths for project-specific guidance.
16+
17+
- [DataFusion Python](https://datafusion.apache.org/python/): Python bindings — SQL and lazy DataFrame API over Apache Arrow.
18+
- [DataFusion Ballista](https://datafusion.apache.org/ballista/): distributed execution extension for DataFusion.
19+
- [DataFusion Comet](https://datafusion.apache.org/comet/): Apache Spark accelerator built on DataFusion.
20+
21+
## Optional
22+
23+
- [Blog](https://datafusion.apache.org/blog/): release notes and ecosystem updates.
24+
- [crates.io `datafusion`](https://crates.io/crates/datafusion): published crate.
25+
- [Code of conduct](https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md)
26+
- [Apache Software Foundation](https://apache.org)

0 commit comments

Comments
 (0)