Describe difference between docs and articles

[justinfagnani]

Code of conduct

• I agree to follow this project's 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:

• News or announcements
• Otherwise not evergreen and relevant for a point-in time ("New web component features in Safari 16")
• Opinion, advocacy, or comparisons
• Very specific techniques or code patterns
• How-Tos
• Tutorials

We can record this somewhere in the /plan folder.

Related link(s)

No response

Are you interested in authoring this content?

• Yes