docs: the API reference is almost empty

[kazizi55]

Hi @fabian-hiller ,
if it’s not too much trouble for you, I'm willing to write the API reference together! 😄
How can I help you?
What's your plan to complete the API reference?

[fabian-hiller]

Thank you for creating this issue! Yes, I would appreciate support. If I manage to get a sponsor, I plan to give a part of it to people who support me with the docs.

My current plan is to create the first 1 to 3 API references myself and then get feedback from the community. Once we decide on a consistent format, this can be used as a template to write all further references.

Presumably the API references will be a mix of the docs of Zod and the API references of Modular Forms.

[kazizi55]

@fabian-hiller

I would appreciate support.

So happy to hear that!

If I manage to get a sponsor, I plan to give a part of it to people who support me with the docs.

Wow, wonderful 😄

My current plan is to create the first 1 to 3 API references myself and then get feedback from the community.

Since you seem so busy, may I create the first 1 to 3 API references? 😄

Presumably the API references will be a mix of the docs of Zod and the API references of Modular Forms.

Sounds good!

[fabian-hiller]

Great! Feel free to create a first draft of the string API reference (e.g. as a draft PR) and share your ideas there. We can also work together on this. The goal is to have a first-class API reference by the time we reach v1.

[kazizi55]

@fabian-hiller
OK! I'm gonna create the draft of string API in the coming days!

[danielo515]

So, just to be clear, there are no docs currently for the API ? The link to the API reference points to Any, which is confusing, will be better to have a specific message

[fabian-hiller]

@danielo515 on the left (or bottom on mobile) on our website you can navigate to the different APIs and use the link to the source code on GitHub for now. The code is simple and well documented. Otherwise you can also use TypeBox-Workbench to convert a TypeScript type to Valibot.

We start working on the API reference on our website shortly.

[danielo515]

Sure, that's totally fair, but why link the api docs reference to any ? Wouldn't it be better to not linkt them at all and just add a note about the current state? El vie, 20 oct 2023, 0:05, Fabian Hiller ***@***.***> escribió:

…

@danielo515 <https://github.com/danielo515> on the left (or bottom on mobile) on our website you can navigate to the different APIs and use the link to the source code on GitHub for now. The code is simple and well documented. Otherwise you can also use TypeBox-Workbench <https://sinclairzx81.github.io/typebox-workbench/> to convert a TypeScript type to Valibot. We start working on the API reference on our website shortly. — Reply to this email directly, view it on GitHub <#209 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AARKJWN57QFCNRLKZ3NN5Q3YAGP3BAVCNFSM6AAAAAA5YVMP5OVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONZRG43DSMJWGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[fabian-hiller]

any is just the first page (the first API) of our API reference.

[fabian-hiller]

@kazizi55 have you started a first draft? If not, I might start working on a draft this weekend. For a faster exchange, feel free to connect with me on Discord (fabianhiller).

[kazizi55]

@fabian-hiller
Sorry for my late reply and a first draft 🙇

have you started a first draft?

Yes, I've started a first draft, and maybe will finish making a draft this weekend!

For a faster exchange, feel free to connect with me on Discord (fabianhiller).

Thanks! I'll connect!

[wout-junius]

I am willing to help with the docs as well since I am missing them a lot xD
I'll wait till @kazizi55 PR gets trough to see an example and then I might be able to continue as well ;)

[fabian-hiller]

Thank you @wout-junius! That's means a lot to me. Yes, once the first draft is ready it can be used as an template to add all the other references.

[wout-junius]

So since the first PR for docs has been merged, how do we divide or decide wich pages are done by whom?

[fabian-hiller]

I think the best way is to create a new issue where everyone can add a comment that I will summeries at the top of the issue to prevent two people working on the same reference. What do you think about this? Do you have a better idea?

[fabian-hiller]

I created #287 to coordinate the expansion of our API reference.