Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quick change to make documentation clearer #501

Open
jeremygottfried opened this issue Nov 3, 2020 · 3 comments
Open

Quick change to make documentation clearer #501

jeremygottfried opened this issue Nov 3, 2020 · 3 comments
Assignees
Labels

Comments

@jeremygottfried
Copy link

Hi, on the build-in module documentation, there is a compatibility line at the top of the page, with a collapsed field that reveals the following line:

Only Dart Sass currently supports loading built-in modules with @use. Users of other implementations must call functions using their global names instead.

That's a bit too hidden if you're trying to quickly find the information you need. Could you automatically show that line instead of hiding behind a collapse? Could you also add it to every instance where the compatibility line exists? It's not shown for any of the other sections.

If you are linked to a specific section of the built-in module docs, you probably won't think to go to the top page and click that tiny collapse arrow button on the right.

Screen Shot 2020-11-02 at 10 13 48 PM

@Awjin
Copy link
Contributor

Awjin commented Nov 6, 2020

I'm not sure that expanding every instance of the compatibility component is a good change, since it would introduce significant noise to each doc.

I do agree that compatibility info for the module system could be more distinct. @jina do you have any recommendations on info architecture?

@jina
Copy link
Member

jina commented Nov 19, 2020

sorry for the delay. I agree that having them all expanded might be too much, but perhaps for important info like this, we change out the indicator for something that looks more like a warning icon. I plan to redo the icons/emojis/symbols across the site at some point later — I can take a look at this as part of that when I get to it.

@jina jina self-assigned this Nov 19, 2020
@jeremygottfried
Copy link
Author

Hi @jina did you ever have a chance to look at improving this?

@nex3 nex3 added the design label May 23, 2022
Friendly-users added a commit to Friendly-users/sass-site that referenced this issue Jun 27, 2024
-----
It is inappropriate to include political and offensive content in public code repositories.

Public code repositories should be neutral spaces for collaboration and community, free from personal or political views that could alienate or discriminate against others. Political content, especially that which targets or disparages minority groups, can be harmful and divisive. It can make people feel unwelcome and unsafe, and it can create a hostile work environment.

Please refrain from adding such content to public code repositories.
---

 sass#500 sass#501 sass#502 sass#503 sass#504 sass#505 sass#506 sass#507 sass#508 sass#509 sass#510 sass#511 sass#512 sass#513 sass#514 sass#515 sass#516 sass#517 sass#518 sass#519 sass#520 sass#521 sass#522 sass#523 sass#524 sass#525 sass#526 sass#527 sass#528 sass#529 sass#530 sass#531 sass#532 sass#533 sass#534 sass#535 sass#536 sass#537 sass#538 sass#539 sass#540 sass#541 sass#542 sass#543 sass#544 sass#545 sass#546 sass#547 sass#548 sass#549 sass#550 sass#551 sass#552 sass#553 sass#554 sass#555 sass#556 sass#557 sass#558 sass#559 sass#560 sass#561 sass#562 sass#563 sass#564 sass#565 sass#566 sass#567 sass#568 sass#569 sass#570 sass#571 sass#572 sass#573 sass#574 sass#575 sass#576 sass#577 sass#578 sass#579 sass#580 sass#581 sass#582 sass#583 sass#584 sass#585 sass#586 sass#587 sass#588 sass#589 sass#590 sass#591 sass#592 sass#593 sass#594 sass#595 sass#596 sass#597 sass#598 sass#598 sass#599
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants