Picking up on this thread from last year: For a developer looking to document the elements they're authoring today, do we have an answer we can give them? (I've read through Eric's self-documenting proposal and agree, it's a beautiful vision).
After playing around with the prototype, however it looks like we would need to either agree on an initial base template / format for the documentation element or punt to existing tools like JSDoc (which Eric has already mentioned has it's own issues as we're dealing with a multi-headed beast). I'm primarily interested in this for Polymer tooling/boilerplate projects where recommending documentation practices from the get-go would be super-useful. On Monday, 8 April 2013 20:02:19 UTC+1, Eric Bidelman wrote: > > Inspired by Mike K's great idea of self documenting custom elements, I've > written a proposal to formalize the effort. > We have a great opportunity here to come up with best practices early on. > > *Proposal: Self Documenting Custom Elements <http://goo.gl/X5DxO>* > - prototype <http://goo.gl/0pdSW> - a custom element that uses this > method. > - it's <wc-documentation> <http://goo.gl/qzW7P> (best viewed in > Chrome Canary to get ::distributed()). > > [image: Inline image 1] > > Things I like about this approach: > > - The delivery mechanism is <link rel="import">. > - Becomes the "view source of custom elements". Click an import's link -> > get its docs. > - The docs themselves are custom elements > - works reasonably well in other modern browsers, especially if the > toolkit polyfills are included. > > Looking for everyone's feedback. > > Eric Bidelman > Follow Polymer on Google+: plus.google.com/107187849809354688692 --- You received this message because you are subscribed to the Google Groups "Polymer" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/75b0e259-cd73-4806-b6ee-00cd7b1b7a17%40googlegroups.com. For more options, visit https://groups.google.com/groups/opt_out.
