Intro guide for Vortex
When doing https://github.com/vortex-data/vortex/pull/3906 I couldn't find a way in the documentation to put information about this method - even though debug printing feels like a very important tool for learning a new library
Moreover, as I was getting into the project, I couldn't find a simple cheat sheet on Vortex containing basic ops like:
- how to create a new array (for different types, for example that you want to use VarBin for string)
- how to print them
- how to iterate them
- how to get individual element
- how to modify an array
- how to write it to the file
- and so on
- what's the difference from, e.g.
VarBinArrayfromVarBinView
To be fair, some of those are covered in examples, but it's very slow to iterate over all of them checking if they have something you need.
I think we should have this information as a single page in two ways:
- pretty formatted and concise for humans, with some comments and explanation
- in
vortex.dev/llm.txtfor LLMs. Example:https://alloy.rs/llms-full.txtand https://alloy.rs/introduction/prompting
Doing this feels like a good way to learn the project, so adding gfi
hey! I would like to pick this up if that's okay?
sure
@ptravers That would be fantastic! Let us know if we can help along the way.
great! thanks will start on this today!
hey @ptravers! Just wanted to check if you need any help with the issue 🙂
just reviewing my work before I ping you. I created a cookbook doc and some example rust code in an examples directory. does that make sense to you both?
put up a draft PR. still self reviewing will add you both when ready for final review.