create-t3-app icon indicating copy to clipboard operation
create-t3-app copied to clipboard

feat: improved color scheme for docs

Open c-ehrlich opened this issue 1 year ago β€’ 8 comments

Is your feature request related to a problem? Please describe.

The current docs are fine, but compared to our landing page or the docs of some other projects, they just don't look very good. Beyond (subjective) aesthetics, there are also usability/accessibility issues related to this.

The current color scheme mostly comes from the t3-purple color that we have defined in the Tailwind config. This has a few problems:

  • We don't have a contrast color that would make it easier to draw attention to links and other UI elements
  • Because we're mostly just using one hue, some parts of the UI are fairly low contrast, which can make it hard to read
  • It looks ok but not great

Some references of docs that feel high quality to me:

Describe the solution you'd like to see

Keep it T3 but improve readability and aesthetics

It would be nice if it keeps some kind of reference to purple as this has become part of the T3 "brand" but other than that open to anything.

I would love if the dark mode could be similar to our landing page. Maybe a similar gradient background but a bit more dimmed? Maybe the contrast colors come from the "full-stack, typesafe Next.js" text? But feel free to disregard all of this if you come up with something better that still feels T3.

If you propose something for both light and dark mode, they should feel like they belong together.

This is fundamentally about the color scheme, but if your changes need something else (for example different spacing) to look good, that's ok.

Describe alternate solutions

.

Additional information

Please don't put in a bunch of work making a PR, which may not end up getting merged. If you want to make a proposal, I would suggest one or two screenshots (can be based on real code changes or mocked) of your intended changes, that can be commented on by the community.

c-ehrlich avatar Dec 02 '22 22:12 c-ehrlich

I was playing around with the colors and like the following combination; if it's a path that you think might work, I can make a draft PR and continue with it.

Current:

create t3 gg_en_introduction

Proposed:

Proposal 1: localhost_3000_en_introduction (1)

gabrielelpidio avatar Dec 04 '22 04:12 gabrielelpidio

Proposal 2:

localhost_3000_en_introduction (2)

gabrielelpidio avatar Dec 04 '22 04:12 gabrielelpidio

Also was thinking if we can remove transition from elements when we toggle mode from light to dark and vice versa. Currently some elements change first and some after so imo its not looking good. Maybe something like this?

https://user-images.githubusercontent.com/62164346/205489750-2ee86ee3-e84b-4fc8-932b-483f207c8d90.mp4

I can make a PR if this is good

ParasSolanki avatar Dec 04 '22 12:12 ParasSolanki

Also was thinking if we can remove transition from elements when we toggle mode from light to dark and vice versa. Currently some elements change first and some after so imo its not looking good. Maybe something like this? demo-mode-toggling-video.mp4

I can make a PR if this is good

this might be an issue specific to your OS/browser/etc? here's now it looks for me

https://user-images.githubusercontent.com/8353666/205495761-5f1917fb-091d-403d-b798-63b3a4e2f30d.mov

c-ehrlich avatar Dec 04 '22 14:12 c-ehrlich

Also was thinking if we can remove transition from elements when we toggle mode from light to dark and vice versa. Currently some elements change first and some after so imo its not looking good. Maybe something like this? demo-mode-toggling-video.mp4

I can make a PR if this is good

this might be an issue specific to your OS/browser/etc? here's now it looks for me

https://user-images.githubusercontent.com/8353666/205495761-5f1917fb-091d-403d-b798-63b3a4e2f30d.mov

Yeah it could be

ParasSolanki avatar Dec 04 '22 16:12 ParasSolanki

can i take this issue ??

arunavabasucom avatar Dec 05 '22 12:12 arunavabasucom

Moving around the accent color led to these. Unfortunately I wasn't able to keep the T3-purple like background due to it being too bright and any accent color on the pink/purple shade wouldn't look good

image

image

gabrielelpidio avatar Dec 06 '22 19:12 gabrielelpidio

Thanks to everyone who has posted in here so far and sorry for the radio silence. We're currently evaluating whether we should stay on Astro for the site/docs or switch to a more batteries-included solution like Nextra or Docusaurus, so we've been hesitant to move forward on something like this that would likely be quite a bit of work. Will check back in here soon :)

c-ehrlich avatar Jan 05 '23 04:01 c-ehrlich