Docs/issue 430 update technical documentation to reflect current project status #452

thescientist13 · 2020-12-22T23:28:04Z

Related Issue

resolves #430

Note: this captures the current state of things. Going forward PRs will need to update docs as functionality and features are restored.

Summary of Changes

Lerna doesn't bump www/packages,json on custom pre release versions, had to bump myself fyi
Updates Docs and Getting Started sections to reflect current state of the project (including marking things as Coming Soon and commenting out the docs where the feature is missing now)
Left Plugins section alone since there is. WIP: Transforms API Part 2 - Pre/post transforms #450 open now, where we should start documenting all new features going forward as PRs come in for them
Removed need to escape $ and ``` in code fences (it just works now 🥳 )
Deleted "dead" code / files
Removed code, docs, and test for webpack specific configuration: devServer.host and publicPath
Left a comment on thoughts about layout and organization in website layout, organization, and navigation #325 (comment)
Added some technical design docs to CONTRIBUTING.md
fixed some typos, probably added some new typos, lol

TODO

Confirm environment variables are captured correctly in guides, after unescaping
need to document deprecation of config.publicPath / config.devServer.host that were webpack specific features
Report bug around how <link> tags are detected. Current assumption is wrong, as there is no closing </link> tag involved - created <link> tag detection is incorrectly assuming closing </link> tag (v0.10.0-alpha.1) #457
Review correct side bar headings / nav structure - Docs/issue 430 update technical documentation to reflect current project status #452 (comment) (tracked as part of ensure correct working order of website and expected styles (e.g. shelf and scrolling, docs, markdown plugins, etc) #432)
Proof read, etc

aholtzman · 2020-12-23T01:21:32Z

www/pages/docs/css-and-images.md

+
+
+> If you like your all-the-things-in-JS approach, Greenwood can be extended with [plugins](/plugins/) to support "webpack" like behavior as seeb in the below example:


nit: 'seen'

thescientist13 · 2020-12-23T17:50:19Z

Noticing on the target branch that the headings aren't looking correct, so just a note to self here to review all those and / or fix them if present here.

thescientist13 · 2020-12-28T17:18:37Z

@aholtzman
Could you do me a favor and review these two pages? Now that we don't need to escape $ and the like in our markdown, I'm not sure what the correct escaping / syntax is needed (if any) for these examples to make sure they are correct. Thanks!

aholtzman

changes to escaped charters looks correct.

hutchgrant

This is an excellent update of the docs with some spelling mistakes here and there. I don't agree with the spacing of headings in general, which is also somehow different on getting-started/index.md . The ordered lists need a margin as well as the <code /> elements need a different text color, make sure the selector is p > code and not just code as our prismjs code highlights will be affected otherwise.

edit: also what's the deal with the non-functioning shelf? The headings are not being autolinked via rehype-autolink-headings and rehype-slug. Are they being loaded properly?

hutchgrant · 2020-12-28T20:01:42Z

www/pages/docs/index.md


 ### Sections
+
+To continue learning more abuut Greenwood, please feel free to browse the other sections of our documentation.


hutchgrant · 2020-12-28T20:05:55Z

www/pages/docs/layouts.md

-```js
-import { html, LitElement } from 'lit-element';
+### Page Templates
+Pages in your project will generally want a template so you can control the output of the HTML and include all your own custom components and styles.  By default alll pages will default to looking for a _page.html_ in _templates/ directory within your workspace.  


hutchgrant · 2020-12-28T20:07:42Z

www/pages/docs/front-matter.md

@@ -38,7 +39,7 @@ imports:

 ```

-See our [Markdown Docs](/docs/markdown#imports) for more information about rendering custom elements in markdown files.
+See our [Markdown Docs](/docs/markdown#imports) for more information about rendering custom elements in markdown files. -->


 ### Template


I think it might be worth linking to the templates docs #page-template as well. This way both link to each as they both involve each other.

hutchgrant · 2020-12-28T20:09:49Z

www/pages/docs/markdown.md

@@ -52,5 +28,56 @@ imports:

 > See our [component model docs](/docs/component-model) for more information on authoring custom elements / components.  For information on configuring additional page meta data, see our section on [front-matter](/docs/front-matter/).

+-->


This is visible on page -->

hutchgrant · 2020-12-28T20:14:24Z

www/pages/getting-started/index.md

@@ -6,7 +6,7 @@ index: 3
 ---

 ## Introduction
-First off, thank you for taking the time to check out Greenwood!  As a tool, we hope that you find Greenwood to provide a productive and frictionless developer experience for you that results in performant and engaging experiences for your users.  Under the hood Greenwood is using NodeJS, webpack, babel and a lot of other amazing JavaScript tools to power a modern development workflow based on first class support for the modern web like Web Components, FlexBox, CSS Grid, ECMAScript modules, and all your favorite features!
+First off, thank you for taking the time to check out **Greenwood**!  As a tool, we hope that you find Greenwood to provide a productive and frictionless developer experience for you that results in performant and engaging experiences for your users.  Under the hood Greenwood is using the power of the modern web ([and friends !](/docs/tech-stack/)) to drive a modern development workflow that helps you deliver a modern and perfmant applicatiot site for your users... using the web languages you already know.

 ## Your First Project
 To get things started, we first want to make sure everyone can get their first project up and running as easily and quickly as possible, and so through this guide, we will help walk you through everything you need to get started with your first project, including:


The ordered list needs a margin of like 20px it looks out of place.

hutchgrant · 2020-12-28T20:18:12Z

www/pages/getting-started/index.md

@@ -6,7 +6,7 @@ index: 3
 ---

 ## Introduction
-First off, thank you for taking the time to check out Greenwood!  As a tool, we hope that you find Greenwood to provide a productive and frictionless developer experience for you that results in performant and engaging experiences for your users.  Under the hood Greenwood is using NodeJS, webpack, babel and a lot of other amazing JavaScript tools to power a modern development workflow based on first class support for the modern web like Web Components, FlexBox, CSS Grid, ECMAScript modules, and all your favorite features!
+First off, thank you for taking the time to check out **Greenwood**!  As a tool, we hope that you find Greenwood to provide a productive and frictionless developer experience for you that results in performant and engaging experiences for your users.  Under the hood Greenwood is using the power of the modern web ([and friends !](/docs/tech-stack/)) to drive a modern development workflow that helps you deliver a modern and perfmant applicatiot site for your users... using the web languages you already know.

 ## Your First Project


There are massive margins for top and bottom on heading within the docs but not apparent on this page? Needs to be identical and reasonable gap between sections.

hutchgrant · 2020-12-28T20:30:36Z

www/pages/getting-started/index.md

@@ -6,7 +6,7 @@ index: 3
 ---

 ## Introduction
-First off, thank you for taking the time to check out Greenwood!  As a tool, we hope that you find Greenwood to provide a productive and frictionless developer experience for you that results in performant and engaging experiences for your users.  Under the hood Greenwood is using NodeJS, webpack, babel and a lot of other amazing JavaScript tools to power a modern development workflow based on first class support for the modern web like Web Components, FlexBox, CSS Grid, ECMAScript modules, and all your favorite features!
+First off, thank you for taking the time to check out **Greenwood**!  As a tool, we hope that you find Greenwood to provide a productive and frictionless developer experience for you that results in performant and engaging experiences for your users.  Under the hood Greenwood is using the power of the modern web ([and friends !](/docs/tech-stack/)) to drive a modern development workflow that helps you deliver a modern and perfmant applicatiot site for your users... using the web languages you already know.


perfmant applicatiot

thescientist13 · 2020-12-28T21:00:57Z

Thanks for the feedback @aholtzman / @hutchgrant ! 🙏

@hutchgrant
I will definitely clean up more of those typos, but my plan has been to capture restoring website functionality / behavior as part of #432, as I really wanted to limit the scope of this just to the documentation itself so we don't get further behind in keeping the content up to date as more PRs land.

Please feel free to comment in that issue to report any issues you are seeing, so they can all be catalogued in one place. 👍

addressed feedback and acknowledged that website behavior fixes will happen in another PR

…ect status (#452) * WIP updating docs section of pages * all docs updated first draft * update getting started docs * unescape escaped code fences * delete dead code * update tests and docs based on webpack features removed * incorporate technical design docs * additional corrections and proof reading * final docs tweaks

thescientist13 added 5 commits December 22, 2020 12:28

WIP updating docs section of pages

39b0d2c

all docs updated first draft

904ea54

update getting started docs

ae02354

unescape escaped code fences

1047fd7

delete dead code

c016516

thescientist13 added website Tasks related to the projects website / documentation documentation Greenwood specific docs labels Dec 22, 2020

thescientist13 requested review from hutchgrant and aholtzman December 22, 2020 23:28

aholtzman reviewed Dec 23, 2020

View reviewed changes

thescientist13 self-assigned this Dec 23, 2020

This was referenced Dec 23, 2020

Enhancement/issue 426 restore userland postcss #453

Merged

resolve multiple <slot> elements rendering on the home page #454

Merged

thescientist13 added the question Further information is requested label Dec 24, 2020

thescientist13 mentioned this pull request Dec 28, 2020

ensure correct working order of website and expected styles (e.g. shelf and scrolling, docs, markdown plugins, etc) #432

Closed

10 tasks

thescientist13 assigned aholtzman Dec 28, 2020

update tests and docs based on webpack features removed

bd799dc

aholtzman approved these changes Dec 28, 2020

View reviewed changes

hutchgrant previously requested changes Dec 28, 2020

View reviewed changes

thescientist13 removed the question Further information is requested label Dec 28, 2020

thescientist13 unassigned aholtzman Dec 28, 2020

incorporate technical design docs

d46df95

thescientist13 added the help wanted Extra attention is needed label Dec 29, 2020

additional corrections and proof reading

2397023

thescientist13 removed their assignment Dec 29, 2020

final docs tweaks

407e35d

thescientist13 merged commit 7609dc3 into release/0.10.0 Dec 30, 2020

thescientist13 deleted the docs/issue-430-update-technical-documentation-to-reflect-current-project-status branch December 30, 2020 16:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs/issue 430 update technical documentation to reflect current project status #452

Docs/issue 430 update technical documentation to reflect current project status #452

thescientist13 commented Dec 22, 2020 •

edited

Loading

aholtzman Dec 23, 2020

thescientist13 commented Dec 23, 2020

thescientist13 commented Dec 28, 2020

aholtzman left a comment

hutchgrant left a comment •

edited

Loading

hutchgrant Dec 28, 2020

hutchgrant Dec 28, 2020

hutchgrant Dec 28, 2020 •

edited

Loading

hutchgrant Dec 28, 2020

hutchgrant Dec 28, 2020

hutchgrant Dec 28, 2020

hutchgrant Dec 28, 2020

thescientist13 commented Dec 28, 2020 •

edited

Loading



		> If you like your all-the-things-in-JS approach, Greenwood can be extended with [plugins](/plugins/) to support "webpack" like behavior as seeb in the below example:


		### Sections

		To continue learning more abuut Greenwood, please feel free to browse the other sections of our documentation.

		@@ -52,5 +28,56 @@ imports:

		> See our [component model docs](/docs/component-model) for more information on authoring custom elements / components. For information on configuring additional page meta data, see our section on [front-matter](/docs/front-matter/).

		-->

Docs/issue 430 update technical documentation to reflect current project status #452

Docs/issue 430 update technical documentation to reflect current project status #452

Conversation

thescientist13 commented Dec 22, 2020 • edited Loading

Related Issue

Summary of Changes

TODO

aholtzman Dec 23, 2020

Choose a reason for hiding this comment

thescientist13 commented Dec 23, 2020

thescientist13 commented Dec 28, 2020

aholtzman left a comment

Choose a reason for hiding this comment

hutchgrant left a comment • edited Loading

Choose a reason for hiding this comment

hutchgrant Dec 28, 2020

Choose a reason for hiding this comment

hutchgrant Dec 28, 2020

Choose a reason for hiding this comment

hutchgrant Dec 28, 2020 • edited Loading

Choose a reason for hiding this comment

hutchgrant Dec 28, 2020

Choose a reason for hiding this comment

hutchgrant Dec 28, 2020

Choose a reason for hiding this comment

hutchgrant Dec 28, 2020

Choose a reason for hiding this comment

hutchgrant Dec 28, 2020

Choose a reason for hiding this comment

thescientist13 commented Dec 28, 2020 • edited Loading

thescientist13 commented Dec 22, 2020 •

edited

Loading

hutchgrant left a comment •

edited

Loading

hutchgrant Dec 28, 2020 •

edited

Loading

thescientist13 commented Dec 28, 2020 •

edited

Loading