Add documentation to datafusion-substrait crate about what it does

[alamb]

Is your feature request related to a problem or challenge?

The documentation for the datafusion-substrait crate is pretty much non existent which makes it hard for users to know what it does and how to use it

https://docs.rs/datafusion-substrait/latest/datafusion_substrait/#

Describe the solution you'd like

I would like documentation like datafusion-proto that gives an example and describes what datafusion substrait can be used for

https://docs.rs/crate/datafusion-proto/latest

Describe alternatives you've considered

No response

Additional context

No response

[alamb]

I think this is a good first issue as there is an example of how to make it in datafusion-proto

[caicancai]

I want to try it but it might take me a little time because I don't know the use of datafusion-substrait either

[alamb]

Thanks @caicancai that would be most appreciated

[caicancai]

@alamb Hello, I found some bad links but I'm not sure how to fix them properly, one is https://crates.io/crates/datafusion-proto and one is https://github.com/apache/arrow-datafusion/blob/HEAD/datafusion/proto/examples/expr_serde.rs

[caicancai]

https://crates.io/crates/datafusion-proto/examples
There is no such link

[alamb]

@alamb Hello, I found some bad links but I'm not sure how to fix them properly, one is https://crates.io/crates/datafusion-proto and one is https://github.com/apache/arrow-datafusion/blob/HEAD/datafusion/proto/examples/expr_serde.rs

🤔 https://crates.io/crates/datafusion-proto works for me

And when I click on the examples link I see

https://github.com/apache/arrow-datafusion/blob/HEAD/datafusion/proto/examples/expr_serde.rs

Maybe we need to move the examples into lib.rs so it shows up in rustdoc 🤔

[caicancai]

🤔 https://crates.io/crates/datafusion-proto works for me

And when I click on the examples link I see

https://github.com/apache/arrow-datafusion/blob/HEAD/datafusion/proto/examples/expr_serde.rs

Maybe we need to move the examples into lib.rs so it shows up in rustdoc 🤔

Can you let me try it?

[caicancai]

@alamb Hello, excuse me. I would like to ask where lib.rs is located

[alamb]

@alamb Hello, excuse me. I would like to ask where lib.rs is located

I am referring to https://github.com/apache/arrow-datafusion/blob/main/datafusion/proto/src/lib.rs

The documentation on crates.io https://crates.io/crates/datafusion-proto can be generated locally with a command like

cargo doc -p datafusion-proto --open

[caicancai]

I am very sorry that I have been busy with work recently. I will start this part of work

[caicancai]

@alamb Hello, excuse me. I need to move the test sample here, I don’t remember it clearly, I’m very sorry.
https://github.com/apache/arrow-datafusion/blob/main/datafusion/proto/src/lib.rs