From 1e68422ffcf2767e4d3b9b4ad1275622966776b2 Mon Sep 17 00:00:00 2001 From: Owen Buckley Date: Tue, 14 Jun 2022 12:45:05 -0400 Subject: [PATCH 1/2] add a site structure document to capture top level navigation and content sections --- plan/site-structure.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 plan/site-structure.md diff --git a/plan/site-structure.md b/plan/site-structure.md new file mode 100644 index 0000000..6f180b8 --- /dev/null +++ b/plan/site-structure.md @@ -0,0 +1,9 @@ +# Site Structure + +The below aims to capture the top level site and navigation structure for the documentation site we have in mind. You can find more in depth material related to these sections in this _plan/_ folder on a per section basis. + +1. _/ (Home)_ - Would include featured items, showcase community highlights +1. _/catalog_ - Showcasing a curation of web components +1. [_/docs_](./outline.md) - Technical content related to authoring and using Web Components +1. _/articles_ - Opinionated content from contributing authors about Web Components and the ecosystem at large +1. _/about_ - Meta information about the group, how to contribute and get involved \ No newline at end of file From 7fb7a727e6e6de598d165ef490d7c7b9b8d372d7 Mon Sep 17 00:00:00 2001 From: Owen Buckley Date: Tue, 14 Jun 2022 12:45:28 -0400 Subject: [PATCH 2/2] update CONTRIBUTING.md to call out plan related documentation --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f288e48..f6a3a98 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,8 @@ The first step for any substantive contribution is to either: Issues are where individual reports and Community Group discussions come together such that the eventual consensus can be turned into official language. +> **Note** _For additional context around content and outlining, please see the [plan/](./plan/) directory for more information about our information architecture._ + ## Goals and Non-Goals The main goal of the Web Components Community Group docs-and-guides effort is to provide explanation, advocacy, and documentation of shared web components concepts in a common location that is not tied to any specific web components library. @@ -51,4 +53,4 @@ Please follow the [Pull Request template](https://github.com/w3c/csswg-drafts/bl ## Non-substantive contributions For simple spelling, grammar, or markup fixes unrelated to the substance of a -specification, issuing a pull request without a corresponding issue is acceptable. +specification, issuing a pull request without a corresponding issue is acceptable. \ No newline at end of file