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

How wil we document those components #14

Closed
AndyOGo opened this issue Dec 1, 2017 · 1 comment
Closed

How wil we document those components #14

AndyOGo opened this issue Dec 1, 2017 · 1 comment

Comments

@AndyOGo
Copy link

AndyOGo commented Dec 1, 2017

Each component has some intrinsic features and behaviours.
In special cases or in combination with certain other components it's likely that layout, measurements and other stuff may change.

Concrete examples are the mobile menu (which triggers an unrelated DOM tree from within another component) or the various variations of the footer.

Those intrinsic features and behaviours are reflected by code, either as html, in css or through js. So I don't think that we need to document the related stuff in all code, but we need to find an easy way to do it and make it parseable.

Regarding JS i would use awesome @JSdoc doclets.
And for SCSS I would use awesome @sassdoc doclets

@LucaMele
Copy link
Contributor

closing as new plib version is live. If issue is with v2 still relevant, please re-open

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

No branches or pull requests

2 participants