layer5io / layer5io/docs

[Debt] Rules in `_styles_project.scss` should be shifted to their respective files

Open
#1,171 2 comments 0 reactions 0 assignees View on GitHub
framework/hugo help wanted kind/bug language/css language/javascript
Dominant language
JavaScript
Stars
99
Forks
223
Avg merge
1d 1h
Merged PRs (30d)
17

Description

### Current Behavior
[`assets/scss/_styles_project.scss`](https://github.com/layer5io/docs/blob/929a84e14840010fee135c1135f10396ecb9de8f/assets/scss/_styles_project.scss) has been bloated by the addition of lots of rules that should ideally be in other files. Take [`.td-sidebar`](https://github.com/layer5io/docs/blob/929a84e14840010fee135c1135f10396ecb9de8f/assets/scss/_styles_project.scss#L189) for example: this rule really belongs in [_sidebar-tree.scss](https://github.com/layer5io/docs/blob/929a84e14840010fee135c1135f10396ecb9de8f/assets/scss/_sidebar-tree.scss). There are [some rules in other files](https://github.com/layer5io/docs/blob/929a84e14840010fee135c1135f10396ecb9de8f/assets/scss/_subscription.scss#L27) that belong to the wrong file.

### Expected Behavior
Splitting `_styles_project.scss` would prevent having to deal with a bloated monolith down the line. Other out of place rules should be identified as well to improve the codebase.

---

#### Contributor Guide and Resources
- 📚 [Instructions for contributing to documentation](https://github.com/layer5io/docs/blob/master/CONTRIBUTING.md)
- Layer5 documentation [site](https://docs.layer5.io) and [source](https://github.com/layer5io/docs/)
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/GvB8SudhEOoq3JOvoLaoMs)
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)

Contributor guide

Open the contributing guide

Research direction

Start by reading assets/scss/_styles_project.scss and compare its selectors with the partials, especially _sidebar-tree.scss and _subscription.scss. Inventory rules that clearly belong elsewhere, move them to the appropriate existing files, and verify the documentation site keeps the same styling while _styles_project.scss is no longer a bloated monolith.

Written by the indexing model from the issue text.

Assessment

Tech stack
scss
Domain
frontend
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.