Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore/site structure outline #37

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Chore/site structure outline #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e68422
add a site structure document to capture top level navigation and con…
thescientist13 Jun 14, 2022
7fb7a72
update CONTRIBUTING.md to call out plan related documentation
thescientist13 Jun 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
9 changes: 9 additions & 0 deletions plan/site-structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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