Skip to content

Commit

Permalink
Merge pull request rails#51433 from ryo8000/fix-typo
Browse files Browse the repository at this point in the history
Fixed typo in guides/README.md
  • Loading branch information
vipulnsward authored Mar 28, 2024
2 parents e5d3bac + 63970d9 commit 8e46af8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## About the Project

The Rails Guides Visual Refresh occured in Q1 2024, and was intended to bring the visual style of the guides inline with the rubyonrails.org site.
The Rails Guides Visual Refresh occurred in Q1 2024, and was intended to bring the visual style of the guides inline with the rubyonrails.org site.

## Editing Depedencies
## Editing Dependencies

The editing files for the Guides rebuild reside in `stylesrc` and use SCSS to improve developer experience. The code base relies on `include_media` (https://eduardoboucas.github.io/include-media/) to enable inline media-queries adjustments. We've also relied on the standard `normalize.css` (https://necolas.github.io/normalize.css/) to help bring all browsers together.

Expand All @@ -16,12 +16,12 @@ To generate new guides into static files, type `rake guides:generate` from insid

### Why are you not using CSS variables?

Per the MDN documentation on CSS custom properties (https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties), they are not supported in media or container queries at this point (Feb 2024). They may in future releases, and we should pivot to that when they are more wholistically supported. SCSS variables, because they are interpolated at build, serve a similar purpose and allow us the flexibilty to support much older browsers.
Per the MDN documentation on CSS custom properties (https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties), they are not supported in media or container queries at this point (Feb 2024). They may in future releases, and we should pivot to that when they are more wholistically supported. SCSS variables, because they are interpolated at build, serve a similar purpose and allow us the flexibility to support much older browsers.

### Why do we include LTR and RTL?

LTR/RTL (Left to right/right to left) is a layout change based on the nature of the language the site is being displayed in. Arabic and Farsi are two well known "RTL" languages. If the site is automatically translated, then the layout will adjust (mirror horizontally) to be more in line with the text.

### Why is Dark Mode in a seperate file
### Why is Dark Mode in a separate file

IncludeMedia does not handle `prefers-color-scheme` at this time, so it was extracted.

0 comments on commit 8e46af8

Please sign in to comment.