@@ -3,7 +3,7 @@ title: Contributing to Protocol
33label : Overview
44---
55
6- Protocol, like everything else Mozilla makes, is [ open source] ( https://developer .mozilla.org/docs/Mozilla/Developer_guide/Introduction ) .
6+ Protocol, like everything else Mozilla makes, is [ open source] ( https://wiki .mozilla.org/Contribute ) .
77We welcome contributions from people like you. Yes, you, dear reader, can help us
88make Protocol better and more useful, no matter your skill level or area of interest.
99
@@ -125,7 +125,6 @@ reach the really good stuff but the top-level root folder looks something like:
125125``` text
126126protocol
127127├── assets (Sass, JavaScript, and font files; this is what gets published with the package)
128- ├── bin (scripts that deploy the site to the server)
129128├── components (the HTML components)
130129├── docs (documentation pages [including this one])
131130├── static (media assets for display on the Protocol website, but not part of Protocol itself)
@@ -146,10 +145,10 @@ CSS and JavaScript is in `assets` (we’ll do a deeper dive into that folder sho
146145## Component patterns
147146
148147The Protocol documentation uses [ Fractal] ( https://fractal.build ) and component
149- templates are build with with [ Nunjucks] ( https://mozilla.github.io/nunjucks/ ) , a
148+ templates are built with [ Nunjucks] ( https://mozilla.github.io/nunjucks/ ) , a
150149templating language that is mostly plain HTML with some added enhancements. Each
151150component resides in its own Nunjucks template file (using the extension ` .html ` )
152- along with a ` readme.md ` file (written in [ Markown ] ( https://daringfireball.net/projects/markdown/ )
151+ along with a ` readme.md ` file (written in [ Markdown ] ( https://daringfireball.net/projects/markdown/ )
153152format) with notes and documentation for that component. Many have an accompanying
154153configuration file written in [ YAML] ( https://yaml.org/ ) providing
155154[ contextual data] ( https://fractal.build/guide/core-concepts/context-data.html )
@@ -217,10 +216,9 @@ sass/protocol
217216│ ├── fonts
218217│ ├── forms
219218│ ├── mixins
219+ │ ├── themes
220220│ ├── _functions.scss
221- | ├── _lib.scss
222- | ├── _mixins.scss
223- │ └── _themes.scss
221+ │ └── _lib.scss
224222├── templates
225223├── protocol-components.scss
226224└── protocol.scss
@@ -284,7 +282,7 @@ but if you’re not let’s dig a bit deeper.
284282@import ' ../includes/lib' ;
285283```
286284
287- First, we import the Protocol library file with the decorator ` @use ` : ` includes/_lib.scss ` .
285+ First, we import the Protocol library file with ` @use ` directive : ` includes/_lib.scss ` .
288286To learn more about ` @use ` and ` @forward ` read [ this article] ( https://www.oddbird.net/2019/10/02/sass-modules/ ) .
289287Since that file is a Sass partial we don’t need the underscore prefix or the file extension, just
290288referencing the relative path and filename is enough. That library file in turn
0 commit comments