[starter-kits] Fix starter kits so npm run serve isn't `npm run doc…

…s:serve` (#2300) We want to specify no root directory, such that the README.md instructions make sense. Therefore, by navigating the localhost:8000/dev/index.html as written, you now get your authored element and a much better experience. Previously `npm run serve` was serving the docs directory preventing access to the component. * Add something on root url, so that folks don't get a 404. We recommend in the README.md that the user navigates to /dev/index.html. However you expect `npm run serve` to not 404. Add a tiny stub document that points users in the right direction. Co-authored-by: Andrew Jakubowicz <ajakubowicz@google.com>
lit · Nov 13, 2021 · 8b9dcb4 · 8b9dcb4
1 parent 4d522d8
commit 8b9dcb4
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 2 deletions.
diff --git a/.changeset/metal-news-sin.md b/.changeset/metal-news-sin.md
@@ -0,0 +1,6 @@
+---
+'@lit/lit-starter-js': patch
+'@lit/lit-starter-ts': patch
+---
+
+Fix starter kits so `npm run serve` serves the root directory, and add a link to the `/dev/index.html` component example from `/`.
diff --git a/packages/lit-starter-js/index.html b/packages/lit-starter-js/index.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>Lit Starter Kit</title>
+  </head>
+  <body>
+    <a href="/dev/index.html">Component Demo</a>
+  </body>
+</html>
diff --git a/packages/lit-starter-js/web-dev-server.config.js b/packages/lit-starter-js/web-dev-server.config.js
@@ -14,7 +14,6 @@ if (!['dev', 'prod'].includes(mode)) {
 export default {
   nodeResolve: {exportConditions: mode === 'dev' ? ['development'] : []},
   preserveSymlinks: true,
-  rootDir: 'docs',
   plugins: [
     legacyPlugin({
       polyfills: {

diff --git a/packages/lit-starter-ts/index.html b/packages/lit-starter-ts/index.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>Lit Starter Kit</title>
+  </head>
+  <body>
+    <a href="/dev/index.html">Component Demo</a>
+  </body>
+</html>
diff --git a/packages/lit-starter-ts/web-dev-server.config.js b/packages/lit-starter-ts/web-dev-server.config.js
@@ -14,7 +14,6 @@ if (!['dev', 'prod'].includes(mode)) {
 export default {
   nodeResolve: {exportConditions: mode === 'dev' ? ['development'] : []},
   preserveSymlinks: true,
-  rootDir: 'docs',
   plugins: [
     legacyPlugin({
       polyfills: {