Skip to content
This repository has been archived by the owner on Dec 19, 2024. It is now read-only.

Better documentation #185

Closed
alvarouribe opened this issue May 20, 2016 · 3 comments
Closed

Better documentation #185

alvarouribe opened this issue May 20, 2016 · 3 comments

Comments

@alvarouribe
Copy link

Description

The README.md page could be better explaining how to utilise this element

Expected outcome

Add a quick example or add a reference to the demo page to see an easy example.
I wish that all elements would have the same easy way to explain how to implement/use it
Maybe a small 4 step tutorial to use it

Actual outcome

explains the behaviour of the element without explain how to implement it

Documentation Affected

All

@valdrinkoshi
Copy link
Member

@arthurevans FYI

@valdrinkoshi
Copy link
Member

In general, behaviors should be used/implemented as explained here. In the catalog, it would be helpful to have this link available when the user is on a behavior.
In the catalog demo pages, it is currently not possible to "easily" access to the implementation of test elements (e.g. simple-overlay):
screen shot 2016-05-20 at 10 29 16 am
The only way to do that is to either open the dev-tools, or to click on source on the left drawer-panel of the catalog, and navigate to demo/simple-overlay.html.

@wyattallen
Copy link

The documentation should describe the focus-wrapping feature. Focus wrapping can cause issues such as #184 and #188 and are likely not an expected feature of an overlay. For my part, I had to dig into the source-code to discover the feature and diagnose my issue with it.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants