Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jsudelko opened this issue Jun 30, 2024 · 3 comments
Open

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

jsudelko opened this issue Jun 30, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jsudelko
Copy link

jsudelko commented Jun 30, 2024

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
Copy link
Owner

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

@fabian-hiller fabian-hiller self-assigned this Jun 30, 2024
@fabian-hiller fabian-hiller added the documentation Improvements or additions to documentation label Jun 30, 2024
@benweier
Copy link

benweier commented Jul 7, 2024

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

@fabian-hiller
Copy link
Owner

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants