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
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