Skip to content

Conversation

@hshoff
Copy link
Member

@hshoff hshoff commented Jan 26, 2016

It's great that we added the eslint and jscs links for each rule, but I think there's an opportunity here to reduce the visual clutter a bit for easier reading and skimming. I'm proposing moving the links to a comma separated list at the end of the corresponding rule. I feel it's not too difficult to identify which links are eslint vs jscs, but open to discussion on bringing back the labels.

before:
screen shot 2016-01-25 at 9 49 01 pm

^ seeing all that space used for a label and a link makes me 😢

after:
screen shot 2016-01-25 at 10 01 19 pm

@ljharb

@kesne
Copy link
Contributor

kesne commented Jan 26, 2016

I love this ❤️

@ljharb
Copy link
Collaborator

ljharb commented Jan 26, 2016

I'm down for the line condensing, but I think labelling as "eslint" and "jscs" is critical, especially since there's 0 to N rules that could apply for each.

@hshoff
Copy link
Member Author

hshoff commented Jan 26, 2016

I battled with that too, but here's how I settled on removing the labels:

  • eslint-rule vs jscsRule
  • hovering over the link
  • we can remove 37 instances of eslint and 36 instances of jscs
  • what's the use case where a reader wishes they could get to the eslint rule faster?

@ljharb
Copy link
Collaborator

ljharb commented Jan 26, 2016

hovering isn't a good affordance and doesn't work on mobile :-/

To me it's not about getting to it faster, as much as it's about clearly identifying, at a glance, that we have eslint and jscs rule coverage. The rule names are secondary (but necessary)

@hshoff
Copy link
Member Author

hshoff commented Jan 26, 2016

There came a point where I was thinking to myself, "I shouldn't have done this by hand"...but it was already too late.

@ljharb
Copy link
Collaborator

ljharb commented Jan 26, 2016

LGTM

hshoff added a commit that referenced this pull request Jan 26, 2016
[rule links] reduce visual clutter
@hshoff hshoff merged commit 2a7e19a into master Jan 26, 2016
@hshoff hshoff deleted the move-rules branch January 26, 2016 06:40
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.

4 participants