Initialization of repository

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

Initialization of repository #2

Closed castastrophe closed 3 years ago

castastrophe commented 3 years ago

Setting up a rough architecture for an 11ty-based documentation site.

_site: directory where assets are compiled/published
docs: directory containing templates and markdown files
- _includes
- _layouts
- articles
- guides

I also included the licensing, code of conduct, and contribution guides based on what I saw in other WG repos.

netlify[bot] commented 3 years ago

:heavy_check_mark: Deploy Preview for web-components-wg ready!

:hammer: Explore the source changes: ebc075f4b4d43b78986af1374c96c8ea5fabacc7

:mag: Inspect the deploy log: https://app.netlify.com/sites/web-components-wg/deploys/60d4d4dc217dd00008379c2f

:sunglasses: Browse the preview: https://deploy-preview-2--web-components-wg.netlify.app

castastrophe commented 3 years ago

@Westbrook @bennypowers I was debating integrating rocket into this during the first pass but now I'm thinking maybe we can just move forward with this and add the design tweaks in the next PR?

bennypowers commented 3 years ago

The chief benefit to Rocket in our instance is removing doubts. Styles? done. Navigation? finished.

If you have a plan for those and are committed to implementing it, then we're good.

castastrophe commented 3 years ago

@bennypowers Oh I definitely want to use a component library like rocket for rendering - I was just debating if it was a good enough first pass without that or if I should hold the PR from review until I get more of the design done.

bennypowers commented 3 years ago

Rocket isn't a component library, it's a metaframework and cli over 11ty, web dev server, and rollup.

I think @dakmor could explain more

daKmoR commented 3 years ago

the main benefit would be that we could offload the "theme" e.g. just use what its there and do small adjustments.... and if it improves we can "just" updated.

otherwise, we need to take care of responsive, social media tags/images, production optimizations, ...

I still have this on my todo list 😅 can prioritize it for next week if we want that sooner then later 🤗

castastrophe commented 3 years ago

Closing this in favor of @daKmoR's PR. I opened a fork to bring in the docs and licensing from this though into his set-up.