From 04a1024b6a3ef2700e1c09faea736e134da86a27 Mon Sep 17 00:00:00 2001 From: alstjr7375 Date: Tue, 20 Dec 2022 04:59:55 +0900 Subject: [PATCH] Doc: Developer - Update to the latest information --- docs/Project_Structure.md | 8 +++++--- docs/README.md | 1 + docs/Rules.md | 10 ++++++---- 3 files changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/Project_Structure.md b/docs/Project_Structure.md index 480d383..3ef1f04 100644 --- a/docs/Project_Structure.md +++ b/docs/Project_Structure.md @@ -18,7 +18,7 @@ The overall structure of this project. root |- __tests__/: Mixin spec test |- icons/: Icons, illustrations -|- css/: Build result of SCSS Files +|- css/: Build result of SCSS Files (Don't modify directly!!) |- docs/: Development Documents |- src/: Source files |- src/leptonChrome.scss: Entry of SCSS for Browser UI @@ -32,11 +32,13 @@ root |- package.json: Build setup, package dependency |- LEPTON: Meta infos (branch, version) |- user.js: about:config settings -|- userChrome.css: Entry of css for Browser UI (Don't modify directly!!) -|- userContent.css: Entry of css for Web pages (Don't modify directly!!) +|- userChrome.css: Entry of css for Browser UI (Modify only when customizing!!) +|- userContent.css: Entry of css for Web pages (Modify only when customizing!!) |- yarn.lock: Auto generated dependency (Don't modify directly!!) ``` +If you first come, it's a good idea to see the [`/src/leptonChrome.scss`](/src/leptonChrome.scss) and [`leptonContent.scss`](/src/leptonContent.scss) files to understand the flow. + ## Icon files Most of them are made in SVG. diff --git a/docs/README.md b/docs/README.md index 6f00496..3174acb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -103,6 +103,7 @@ Start Guide: CSS, SASS Documents: - [MDN: CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) - [MDN: Introducing the CSS Cascade](https://developer.mozilla.org/en-US/docs/Web/CSS/Cascade) +- [MDN: Introducing the CSS Specific](https://developer.mozilla.org/en-US/docs/Web/CSS/Specificity) - [SASS(SCSS)](https://sass-lang.com/documentation) - [SASS Live Compile](https://www.sassmeister.com/) diff --git a/docs/Rules.md b/docs/Rules.md index dbb4ce8..12f226c 100644 --- a/docs/Rules.md +++ b/docs/Rules.md @@ -45,13 +45,15 @@ It comes from [#109](https://github.com/black7375/Firefox-UI-Fix/issues/109#issu Stable: Only bugfix, Documentation. - `master`: Common bugfix, documentation. -- `photon-style`: Bugfix, documentation specified in `photon-style`. -- `proton-style`: Bugfix, documentation specified in `proton-style`. +- `photon-style`: Config, documentation specified in `photon-style`. +- `proton-style`: Config, documentation specified in `proton-style`. Development: New Features. - `dev`: Common new features. -- `photon-style-dev`: New features specified in `photon-style`. -- `proton-style-dev`: New features specified in `proton-style`. +- `photon-style-dev`: New config specified in `photon-style`. +- `proton-style-dev`: New config specified in `proton-style`. + +After version [`v5.0.0`](https://github.com/black7375/Firefox-UI-Fix/releases/tag/v5.0.0), the distribution is just a [setting difference](https://github.com/black7375/Firefox-UI-Fix/wiki/Options#distribution-settings). ## Edit ### Modify only source file