Add documentation files and update README

[M4ikel79]

This PR adds comprehensive documentation including API reference, developer guide, and user guide. Also updates the README with relevant information.

[siduck]

i havent read the whole pr yet, i hope its not AI generated

[M4ikel79]

Oh Okay, it wasn't AI only the README and vimdoc that were modified using AI.

…

On Tue, Dec 30, 2025, 2:44 AM Sidhanth Rathod ***@***.***> wrote: *siduck* left a comment (nvzone/volt#13) <#13 (comment)> i havent read the whole pr yet, i hope its not AI generated — Reply to this email directly, view it on GitHub <#13 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BU7GNHAHOSSR5D7TBTMWWTT4EHKGLAVCNFSM6AAAAACQI4NMM2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTMOJYGAYTKNBTHA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[siduck]

Oh Okay, it wasn't AI only the README and vimdoc that were modified using AI.
…
On Tue, Dec 30, 2025, 2:44 AM Sidhanth Rathod @.> wrote: siduck left a comment (nvzone/volt#13) <#13 (comment)> i havent read the whole pr yet, i hope its not AI generated — Reply to this email directly, view it on GitHub <#13 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/BU7GNHAHOSSR5D7TBTMWWTT4EHKGLAVCNFSM6AAAAACQI4NMM2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTMOJYGAYTKNBTHA . You are receiving this because you authored the thread.Message ID: @.>

are you sure cuz the entire docs feels like ai to me :(

[M4ikel79]

Yeah, most of it is AI-generated. I fed it the volt codebase and had it write the docs structure. Then I went through and fixed examples/added stuff based on how volt actually works.

The API reference and code examples are mostly accurate since I tested them, but the tone/structure is definitely AI.

Should I close this or want to keep any parts?