Skip to content

Comments

doc: Add Sass language documentation, new compression.#953

Open
MohamedAbdElwahabOka wants to merge 1 commit intolive-codes:developfrom
MohamedAbdElwahabOka:Add-sass
Open

doc: Add Sass language documentation, new compression.#953
MohamedAbdElwahabOka wants to merge 1 commit intolive-codes:developfrom
MohamedAbdElwahabOka:Add-sass

Conversation

@MohamedAbdElwahabOka
Copy link
Contributor

@MohamedAbdElwahabOka MohamedAbdElwahabOka commented Feb 24, 2026

What type of PR is this? (check all applicable)

  • ✨ Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • ♻️ Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert
  • 🌐 Internationalization / Translation

Description

This PR adds the documentation for the Sass (indented syntax) language page, which was previously a placeholder (TODO...).

The new documentation includes:

  • Introduction and syntax distinction between Sass and SCSS.
  • Live interactive demo showcasing Sass indented syntax (variables, nesting, mixins).
  • Technical details about the compiler (Dart Sass) and code formatting.
  • Links to official resources and related LiveCodes features.

Related Tickets & Documents

#769

Desktop Recordings

Timeline.1.mp4

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Added to documentations?

  • 📓 docs (./docs)
  • 📕 storybook (./storybook)
  • 📜 README.md
  • 🙅 no documentation needed

Summary by CodeRabbit

  • Documentation
    • Enhanced Sass documentation with an interactive code demonstration
    • Added detailed language information, compiler details, custom settings guidance, and code formatting resources

@netlify
Copy link

netlify bot commented Feb 24, 2026

Deploy Preview for livecodes ready!

Name Link
🔨 Latest commit 20c3211
🔍 Latest deploy log https://app.netlify.com/projects/livecodes/deploys/699e15d99402470008644f40
😎 Deploy Preview https://deploy-preview-953--livecodes.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@sonarqubecloud
Copy link

@coderabbitai
Copy link

coderabbitai bot commented Feb 24, 2026

Walkthrough

This change adds comprehensive documentation for the Sass language by replacing a placeholder with a full LiveCodes-based interactive demonstration. The documentation includes language metadata, compiler details, configuration examples, code formatting guidance, a starter template, and relevant links.

Changes

Cohort / File(s) Summary
Sass Language Documentation
docs/docs/languages/sass.mdx
Replaced placeholder with complete Sass language documentation including LiveCodes demo configuration, usage notes, language info, compiler details, custom settings, code formatting, starter template, and related resources.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title mentions 'Add Sass language documentation' which aligns with the main change, but also includes 'new compression' which is not present in the changeset. Remove 'new compression' from the title or clarify what compression changes are included. The title should accurately reflect only the changes in this PR.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The PR successfully adds comprehensive Sass language documentation including demo, compiler details, and resources, directly fulfilling the objective in issue #769 to add missing language docs.
Out of Scope Changes check ✅ Passed All changes are focused on adding Sass documentation to docs/docs/languages/sass.mdx. No unrelated modifications to other systems or features are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/docs/languages/sass.mdx (1)

35-37: Mixin name flex-center doesn't center anything.

The mixin only sets display: flex and gap: 1em. Naming it flex-center implies horizontal/vertical centering (align-items/justify-content). Either rename it (e.g., flex-row) or add the centering properties to match the intent.

♻️ Proposed fix
-=flex-center
-  display: flex
-  gap: 1em
+=flex-row
+  display: flex
+  gap: 1em

And update the include:

-.features
-  +flex-center
+.features
+  +flex-row

Or keep the name and add actual centering:

 =flex-center
   display: flex
+  align-items: center
+  justify-content: center
   gap: 1em
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/docs/languages/sass.mdx` around lines 35 - 37, The mixin named
`flex-center` only sets `display: flex` and `gap: 1em` so it doesn't actually
center content; either rename the mixin to something like `flex-row` to reflect
its behavior, or modify the `=flex-center` mixin to add centering properties
(e.g., `align-items: center` and `justify-content: center`) and update any
places that include `flex-center` accordingly so the name and behavior match.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/docs/languages/sass.mdx`:
- Around line 113-115: The "## Code Formatting" section incorrectly states
Prettier supports .sass; update that section (the "## Code Formatting" heading
in the SASS doc) to state that Prettier does not support the indented .sass
syntax (cite that PostCSS doesn't parse Sass and reference the long‑standing
issue), and either remove the Prettier mention or replace it with a short note
saying "No official formatter available for .sass; consider converting to .scss
or using editor linting tools" following the pattern used in other language docs
that lack formatters.

---

Nitpick comments:
In `@docs/docs/languages/sass.mdx`:
- Around line 35-37: The mixin named `flex-center` only sets `display: flex` and
`gap: 1em` so it doesn't actually center content; either rename the mixin to
something like `flex-row` to reflect its behavior, or modify the `=flex-center`
mixin to add centering properties (e.g., `align-items: center` and
`justify-content: center`) and update any places that include `flex-center`
accordingly so the name and behavior match.

ℹ️ Review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2be91f3 and 20c3211.

📒 Files selected for processing (1)
  • docs/docs/languages/sass.mdx

Comment on lines +113 to +115
## Code Formatting

Using [Prettier](https://prettier.io/).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Prettier does not support .sass (indented syntax) — this claim is incorrect.

Prettier's CSS support is powered by PostCSS, which handles CSS, Less, and SCSS — but as noted in Prettier's own release notes, "postcss right now doesn't parse Sass nor Stylus." This has remained true through subsequent versions. A long-standing open issue (#4948) titled "Understands .scss but not .sass files" confirms that Prettier cannot format the indented .sass syntax.

The "Code Formatting" section should either be removed or corrected to reflect that Prettier is unavailable for this language. Check how other language docs in the project handle the absence of a formatter.

🛠️ Suggested correction
 ## Code Formatting

-Using [Prettier](https://prettier.io/).
+Code formatting is not supported for the Sass indented syntax. [Prettier](https://prettier.io/) supports SCSS (`.scss`) but not the indented `.sass` syntax.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/docs/languages/sass.mdx` around lines 113 - 115, The "## Code
Formatting" section incorrectly states Prettier supports .sass; update that
section (the "## Code Formatting" heading in the SASS doc) to state that
Prettier does not support the indented .sass syntax (cite that PostCSS doesn't
parse Sass and reference the long‑standing issue), and either remove the
Prettier mention or replace it with a short note saying "No official formatter
available for .sass; consider converting to .scss or using editor linting tools"
following the pattern used in other language docs that lack formatters.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant