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

Delete references to polymer-cli from main docs, and link to open-wc #919

Closed
mercmobily opened this issue Mar 9, 2020 · 12 comments
Closed

Comments

@mercmobily
Copy link

polymer-cli "works" but it hasn't received a real commit for over 8 months, and issues are piling up quickly. It's not a good look.

Using es-dev-server would be a much better idea -- and it will give developers a much better idea of what they should actually use.

The very first page of lit-element's documentation links to https://github.com/PolymerLabs/start-lit-element which had its last commit 1 year ago and refers to polymer-cli.

Also, it would be graceful to have a link to open-wc from the documentation.

I think a section "Writing apps" would ideally link to open-wc, and summarise what's provided with npm init @open-wc.

Right now, lit-element is telling users to use an effectively abandoned repository to serve elements, an outdated "hello world" project and no mention of how to create a full app, which is most people's goals.

@mercmobily mercmobily changed the title IMPORTANT: delete references to polymer-cli from main docs IMPORTANT: delete references to polymer-cli from main docs, and link to open-wc Mar 9, 2020
@arthurevans
Copy link
Contributor

We're working on a replacement for this getting started guide that provides a more modern starting point (and no Polymer CLI).

@mercmobily
Copy link
Author

Are you going to suggest people to use es-dev-server? What about a link to open-wc?

@arthurevans
Copy link
Contributor

Yeah, the new starter project (https://github.com/PolymerLabs/lit-element-starter-ts is the working version, typescript flavor) uses es-dev-server. (There will probably be links to open-wc as well; that's where we're pointing people for an app project scaffold at the moment.)

@mercmobily
Copy link
Author

mercmobily commented Mar 12, 2020

I realise that lit is typescript, but please keep your heart open to people who use ES6 rather than typescript to do things.

@arthurevans
Copy link
Contributor

Heck @mercmobily, I don't even know TypeScript. The first version is TypeScript because it has more moving parts. There'll be a JavaScript version, too, for folks like you and me.

@mercmobily
Copy link
Author

@arthurevans Ahhahahah that makes 2 of us :D The amount of moving parts (as well as the super-verbose code -- I hate types!) is what keeps me WELL away from TS...

@nweldev
Copy link

nweldev commented Apr 9, 2020

So @mercmobily, do you think moving the docs from polymer-cli to open-wc is still on the table, or should we wait for the new starter project? In the first case, I would be happy to send a PR for that as I'm currently working on this topic.

@shipagency
Copy link

@arthurevans how is the progress on getting the docs updated?

@arthurevans
Copy link
Contributor

@shipagency Hoping to get a public draft out this week.

@arthurevans
Copy link
Contributor

New draft is staged here: https://new-getting-started-dot-polymer-lit-element.appspot.com/guide/start
PR is here, if you have feedback: #969

@justinfagnani justinfagnani changed the title IMPORTANT: delete references to polymer-cli from main docs, and link to open-wc Delete references to polymer-cli from main docs, and link to open-wc Apr 20, 2020
@mercmobily
Copy link
Author

Wow... just WOW. This is going to be the best Getting Started I've seen in a very, very long time!
Really impressive work. I like the reference to the open-wc generator.
I am humbled by how well this is written.

@arthurevans
Copy link
Contributor

Thanks for the kind words, @mercmobily ! Update is live, closing.

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

4 participants