knative / docs

User documentation for Knative components.
https://knative.dev/docs/
Other
4.41k stars 1.22k forks source link

Suggesting Necessary UI Changes on the Docs feature #6012

Open sandipkumardey opened 3 weeks ago

sandipkumardey commented 3 weeks ago

Hi team, I've found some major bugs and potential design improvements on the Doc feature as a Designer myself. This is my very first open-source contribution. And I really like the project idea...

Listing all changes one by one-

Screenshot 2024-06-07 at 11 15 49 PM
  1. Navigation bar: There should be an accent color when someone changes different tabs on the page, the current nav bar does not have a contrast between the texts.
  2. Ttilte Text: The title text should have a different color and must not match the color of the body text on the page, that's key.
  3. The right extreme nav bar is not mandatory and just taking up the extra white space. Keep only about us on the right and others on the main nav bar on the left.
  4. Similar to the nav bar, the right table of contents is pointless. People read text from left to right, so it should be merged on the left with the subtopics, the list can be extended as the user drops down, OR it can be removed entirely.
Screenshot 2024-06-07 at 11 18 01 PM
  1. Last, the arrows can have accent color as suggested earlier.

I hope the above suggestions are worth taking note of and were useful, thank you!