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

Default indicators hidden #595

Merged
merged 8 commits into from
Dec 6, 2024
Merged

Default indicators hidden #595

merged 8 commits into from
Dec 6, 2024

Conversation

keyserj
Copy link
Collaborator

@keyserj keyserj commented Dec 6, 2024

Closes #478

Description of changes

  • see commit messages

Additional context

even if editing, always showing these isn't necessary.
so that there's tailwind intellisense
going to revert this because it seems jarring when you hover
something and it reveals something that's immediately hovered,
e.g. hover edge -> hovering score.

wanted to keep this commit in case it's valuable to refer back
to the logic later.
because it seems jarring when you hover
something and it reveals something that's immediately hovered,
e.g. hover edge -> hovering score.

keeping the change to use css instead of js for show/hiding
because it seems a little cleaner; could consider js for
performance improvements in the future (because it could
prevent running rendering logic).

also keeping diagram-node/-edge classes because they seem probably
useful in the future.
having indicators off makes the diagram much easier to read,
and new users won't know how to use indicators right away anyway.

will want to make sure zen mode is pointed out early in tutorial
though, so users can still take advantage of indicators when they
become useful to them.
because with new diagrams, it commonly results in pretty spread out
diagrams, trying to avoid crossings for long problem-solution edges.

it also sometimes creates poor left-to-right ordering within a layer.
it's clearer about what it does.
This was annoying to do because of the reasons below, but since we're
defaulting indicators to hidden, we have to ensure docs mention it
(since users would otherwise be confused when getting to "scores" in
the docs).

I think the button name is slightly suboptimal because:
- Score is more interactive than just an Indicator

Also these docs updates are a little suboptimal because:
- the button is only explained in the Scoring section; hopefully
users can understand its use for the indicator section, but it seems
annoying to duplicate the explanation there too.

It's possible that "show scores" should be a separate button, but:
- both would often be on/off together
- both would need separate tutorial/docs mentions?
Copy link

netlify bot commented Dec 6, 2024

Deploy Preview for velvety-vacherin-4193fb ready!

Name Link
🔨 Latest commit 26ff555
🔍 Latest deploy log https://app.netlify.com/sites/velvety-vacherin-4193fb/deploys/675380f0be926d0008f0eb7e
😎 Deploy Preview https://deploy-preview-595--velvety-vacherin-4193fb.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 86
Accessibility: 86
Best Practices: 92
SEO: 100
PWA: 80
View the detailed breakdown and full score reports

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

Copy link

netlify bot commented Dec 6, 2024

Deploy Preview for ameliorate-docs ready!

Name Link
🔨 Latest commit 26ff555
🔍 Latest deploy log https://app.netlify.com/sites/ameliorate-docs/deploys/675380f0809b840008ee57b7
😎 Deploy Preview https://deploy-preview-595--ameliorate-docs.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 site configuration.

@keyserj keyserj merged commit b6bfd6c into main Dec 6, 2024
13 checks passed
@keyserj keyserj deleted the default-indicators-hidden branch December 6, 2024 23:07
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.

Options to reduce diagram clutter
1 participant