old-docs-site icon indicating copy to clipboard operation
old-docs-site copied to clipboard

Try Polymer example codes contain unrefered files.

Open jongmana opened this issue 6 years ago • 1 comments

It seems to me that the code examples like the custom-element example of 3.0/start/samples/custom-element/ have two issues.

  1. When one follows the StackBlitz link on the documentation site, there is an index.js file that wasn't mentioned on the documentation site; If I delete it I'll get an error that index.js is missing. For me it's unclear whether this file is required by Polymer or by StackBlitz.
  2. The custom-element file is "custom-element.js" the index.html however doesn't import that file but rather "custom-elements-es5-adapter.js", which is confusing for people starting with polymer (coming from Polymer 2.x, so I expected to import custom-element.js in the index file). The confusion might also be triggered because the element is called Custom-Element and the library imported is custom-elements.

jongmana avatar May 10 '18 21:05 jongmana

Thanks for the feedback. Index.js is indeed required by stack blitz, and the custom elements adapter, is required when transpiling to ES5, which stackblitz does for us.

I think we can add some comments to explain the difference between the samples shown on the site and in stackblitz.

arthurevans avatar May 11 '18 14:05 arthurevans