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

Describe difference between docs and articles #36

Open justinfagnani opened 2 years ago

justinfagnani commented 2 years ago

Code of conduct

Description of request

We've talked about the difference between reference/conceptual docs and articles in several meetings. We should record this in the repo for our memory and guidance for new contributors.

Docs: Primarily objective reference and conceptual topics that fit into a single organizing hierarchy. Docs have a well-defined outline which forms the navigation of the docs section of the site. Docs should be presenting objective information, with the large exception of a main objective for the site, which is advocacy for web components.

Articles: Articles basically everything else (that is not covered in specific top-level section of the site, like /about). They are a loose collection of topics that may have one or more of the following traits:

We can record this somewhere in the /plan folder.

Related link(s)

No response

Are you interested in authoring this content?