search

webcomponents-cg / docs-and-guides

Web Component Community Group - We care about web components.
https://webcomponents-cg.netlify.app/
Creative Commons Zero v1.0 Universal
26 stars 3 forks source link

Add initial content outline #16

Closed justinfagnani closed 2 years ago

justinfagnani commented 2 years ago

Fixes #13

This is preliminary - I added a bunch of sections I thought reasonable, but it's all up for changes.

I think we should emphasize that the outline is a living document and probably spend some amount of time massaging it here, but not try to get it perfect right away and iterate in PRs.

We should probably also add a note about our intended workflow: like if you pick a page to write, make an issue and link to it from the outline? We could also proactively make a bunch of issues, but that might require more synchronization work as the outline changes. Once we get content in place, if we make a change to the outline we'll want to know where it's out of sync and needs content changes to bring it into sync - or, once we get enough content we retire this document in favor of the actual content structure.

netlify[bot] commented 2 years ago

✔️ Deploy Preview for web-components-cg ready!

🔨 Explore the source changes: 4cbda4d9a70e954c5c066e7eb61df64447b6a0ab

🔍 Inspect the deploy log: https://app.netlify.com/sites/web-components-cg/deploys/6196de6a26250800086a260d

😎 Browse the preview: https://deploy-preview-16--web-components-cg.netlify.app

castastrophe commented 2 years ago

👍 Looks great!

kevinpschaaf commented 2 years ago

Looks good, just a few suggestions.