mozilla / mozilla/protocol

Protocol docs should show how to import SCSS

Open
#881 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation :memo:
Dominant language
SCSS
Stars
298
Forks
83
Avg merge
16h 48m
Merged PRs (30d)
1

Description

The Protocol docs now show how to import JS for each component.

import MzpNavigation from '@mozilla-protocol/core/protocol/js/navigation';

It would be helpful if we also did this for SCSS as well?

@import '~@mozilla-protocol/core/protocol/css/components/navigation';

https://protocol.mozilla.org/components/detail/navigation--default.html

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the Protocol component documentation page linked in the issue, especially navigation--default.html, and compare its existing JavaScript import example. Add the corresponding SCSS import example for the components, then verify the rendered documentation shows it alongside the JavaScript example.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, scss
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.