apache
Update README occording to the new examples (#18529)
Which issue does this PR close?
- Closes #https://github.com/apache/datafusion/issues/18529.
Rationale for this change
What changes are included in this PR?
Are these changes tested?
Are there any user-facing changes?
High Level Overview
This PR restructures and improves the organization of the README for datafusion-examples directory to make it significantly easier for users to discover, understand, and run examples. The main goals are consistency, clarity, and improved developer experience. The tables provide a quick and complete overview of the available examples.
Note: The ffi_xyz crate is not included, as it's not a runnable example. It also currently does not appear in the README. If needed, a follow-up PR can clarify its purpose and documentation.
For anyone else who is curious, you can see it rendered at this page: https://github.com/cj-zhukov/datafusion/tree/cj-zhukov/update-readme-occording-to-the-new-examples/datafusion-examples
@Jefffrey since you originally suggested using the tabular format for organizing the examples, you might be interested in taking a look at this PR.
Thanks @cj-zhukov -- this look like a nice improvement to me
I wonder if there is any way to ensure this document stays in sync with the code. For example, if someone adds a new example, how do we ensure that an appropriate entry is added here 🤔
Maybe we could add a ci check similar to the config doc check
https://github.com/apache/datafusion/blob/2a08013af3ccf703bee202c959b40bb0d35bdea1/.github/workflows/rust.yml#L683-L710 🤔
This would be great if automated! I've opened a follow-up PR for that https://github.com/apache/datafusion/issues/19294