Homepage consistency #3294
josephernest
started this conversation in
3. Feature Ideas
Replies: 1 comment
-
|
This issue has been converted to a discussion as we are now using discussions to track bugs and ideas. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Discussed in #3028
Originally posted by josephernest July 10, 2022
Congrats for this great project.
When you have your first contact ever with Alpine on https://alpinejs.dev/, you are happy to see that "everything is included" in "15 attributes, 6 properties, 2 methods". This is excellent branding (and more libraries should do this!) because you know in advance that it will be lightweight (which is a awesome).
Then I look at the top example:
and I see
@click="...". I'm then thinking: Let's discover which of these 15 attributes is this!. After a few minutes, you see that@...isn't listed in the "15 attributes", and then you start thinking the promise "15 attributes only" is wrong.Of course after a few more minutes, you discover elsewhere (after a google search etc) or in another documentation page that
@...is just a shortcut forx-on:...but this isn't obvious on first contact with the library.Suggestion of modification: replace
@clickbyx-on:clickin the first example in the homepage https://alpinejs.dev/, so that the newcomers are not lost at the beginning. It will be more consistent with the rest of the home page documentation.Alternatively, you can also include in the homepage, in the list of 15 attributes:
Beta Was this translation helpful? Give feedback.
All reactions