search

fabian-hiller / valibot

The modular and type safe schema library for validating structural data 🤖
https://valibot.dev
MIT License
6k stars 186 forks source link

First-person voice in the docs are a pain read #687

Open jsudelko opened 3 months ago

jsudelko commented 3 months ago

The first-person Valibot voice seems cute but has been a terrible experience when you just want to get work done and some random sentence is written in first person. I'm often broken out of flow often to translate into third person to understand what it means.

In addition, I can help you to perform more detailed validations and transformations with the pipe method.

😒

1) It is harder to read. It is likely often 0 value for developers and in my case almost always negative value. 2) It probably harder to write for you (and contributors). Writing in first-person likely needs you to mentally translate from a "regular" voice only for us readers to mentally translate it back.

Please write docs normally. No first-person please.

fabian-hiller commented 3 months ago

Thank you for your feedback. I will consider it in the long run.

benweier commented 2 months ago

For what it's worth, I love the personality this brings to the docs but can understand it's not for everyone

fabian-hiller commented 2 months ago

I agree. Up until now, the current approach has had many benefits for the project. It has helped us tell a story and differentiate ourselves from other projects.

vladshcherbin commented 2 months ago

Oh wow, I also wanted to create same issue long time ago. Reading the docs always felt so weird, happy to see I'm not the only one 😅 Never had such issue with other libraries docs though.

fabian-hiller commented 2 months ago

Thank you for your feedback!