mountain_view icon indicating copy to clipboard operation
mountain_view copied to clipboard

Consider moving sample below usage information

Open ChristineP2 opened this issue 6 years ago • 3 comments

Here are samples of some of the options available for positioning. I propose one of the options where title/description are before the sample may be a more pleasing solution overall. As far as positioning of the component relative to the title and usage information, it seemed like there are basically ~~4~~ 5 options:

I thought of this after I'd finished doing all the screen shots, but I could pull the title out above everything, instead of leaving it inside the description div, so that's the 5th option.

Here are the 4 options I took screenshots for:

Before everything like it is now

sample_before_description

Between Title and usage instructions

sample_between_title_and_usage

After Title and Usage Instructions

sample_after_title_and_usage

After Description

sample_after_description

ChristineP2 avatar Oct 11 '18 14:10 ChristineP2

I don't have a strong opinion on this, except that I'd say it's best for the component to be outside the gray container with the code example. So leaning towards

"Before everything like it is now" and "After Description". Pulling the title out of the gray container can also be an interesting option (and I'd still keep the component out of it as well) Ping @devnacho for design feedback.

kitop avatar Oct 17 '18 10:10 kitop

Thanks @ChristineP2 for your proposal!

I agree with @kitop that it's best for the component to be outside the gray container and I think that a good option to experiment would be:

  • Title
  • Component
  • Gray cointainer with code

devnacho avatar Oct 17 '18 12:10 devnacho

I like the idea of title, component then usage in the gray container. I'll theoretically try that this weekend as well :)

ChristineP2 avatar Oct 17 '18 19:10 ChristineP2