-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
suggestion: docs should show javascript when required #160
Comments
Which examples are missing javascript that you found confusing? I'd be happy to visit this on a case by case basis in the docs. |
Thanks for following up. Not sure if I didn't understand the navigation layout or if things have been added since I wrote that some months back. The modules have a nice layout with documentation - examples - usage -settings. Although "sticky" doesn't have the documentation tab they are all there. But back to the Button area. How does the Follow/Following button work in the very first example? When I expand the code, all I see is the "active/following" HTML. Where does the "follow" come from? Why does it change? Is there a hook in the framework or do I use my own jquery to make that happen. Compare that to the Animated variant where all the code to make it work is in the expanded code area for the example - and the animation is declarative. And this might be a more complex behavior, but I'm sure it is a primary use case for a responsive framework. I had a really hard time figuring out how to use menu and pusher to create a responsive menu. It's hidden under Layouts --> Pages and even then only in the "homepage" example I think. Not obvious at all. And I don't see a link/callout anywhere in menu to help guide a user there. Although outside the scope of javascript examples, I'll mention another inconsistency is with the "container" area. While all the other elements have a simple layout, it has multiple tabs. It makes sense on its own, but its a little jarring as a new reader while reading that section. And it would be really nice if when you select an element the left menu didn't start at the top on the new page but kept some contextual frame of reference to where you were in the menu. It makes it really hard to get an initial overview of elements, like if you wanted to check out all the modules one by one. So all these things, as a new user, made it hard for me to really dive in. I find the whole idea of a "semantic" declarative framework far more attractive than something like bootstrap and it was disappointing to get stumped a few times like this so thanks for taking it on and sharing all your work! |
I think it would be nice if the docs went into the javascript a little bit more when that is required. The button page is a great example - I mean a button does nothing without the javascript. That may seem obvious, but other items, like reveal work as if by magic with the semantic framework javascript and nothing custom except markup. Don't need a tutorial on jquery, but a note that making the button work as in the demo requires jquery code, not just HTML markup helps context - especially if you just read about another element that just works with markup.
It isn't too hard to figure out, but you have to think a little too much when you are already just trying to wrap your head around all the cool stuff semantic has to offer.
The text was updated successfully, but these errors were encountered: