webcomponents / webcomponents.github.io

WebComponents.org is where community-members document Web Components best practices
http://webcomponents.org
733 stars 118 forks source link

Flesh out the best practices guide #82

Closed addyosmani closed 9 years ago

addyosmani commented 10 years ago

The community have recently re-enforced their desire to see web components also tackle issues around accessibility, performance, testing and so forth. Whilst these are generally good for any form of component authorship we should polish up the existing guide to ensure we're not missing anything.

I've also noticed some syntax errors in the guide that need some fixing. I'll update the guide this week or next based as time allows.

zenorocha commented 10 years ago

Having one-guide-to-rule-them-all is nice but those items more deep explanations. I think we should write them separately and tag with "best practices".

That main article could be used to briefly describe our concerns and link to these articles.

jkomoros commented 10 years ago

I think there's value in having one simple overview doc of the consensus best practices that we drive traffic to, and from that link to more in-depth articles for each area. That will help the guidelines have more normative power.

On Thu, Mar 27, 2014 at 11:54 AM, Zeno Rocha notifications@github.comwrote:

Having one-guide-to-rule-them-all is nice but those items more deep explanations. I think we should write them separately and tag with "best practices".

That main article could be use to briefly describe our concerns and link to these articles.

— Reply to this email directly or view it on GitHubhttps://github.com/webcomponents/webcomponents.github.io/issues/82#issuecomment-38845722 .

addyosmani commented 10 years ago

I agree fully with @jkomoros (but also with the desire to have more deep-dive explanations, @zenorocha). A good compromise here would be fleshing out the best practices doc and then authoring much more detailed content for each item that we can link to. How does that sound?

zenorocha commented 10 years ago

Sounds perfect.

Just like we did with naming. First we introduced this topic on best practices guide, then we wrote a more deep-dive explanation about them.

Nevraeka commented 9 years ago

also check out our Golden Standard repository

zenorocha commented 9 years ago

Closing this one due to its inactivity