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

docs: refresh web design, fix several html, css and content issues #2831

Open
wants to merge 41 commits into
base: next
Choose a base branch
from

Conversation

tbreuss
Copy link
Contributor

@tbreuss tbreuss commented May 1, 2023

Since there have been discussions about website re-design for a long time, but it did not really move forward, I have been working on this website cleanup branch. Mainly, because some things are a bit embarrassing.

A preview release can be visited here: https://www.mithriljs.tebe.ch/

I see this as a foundation for the next bigger web design update.

Motivation and Context

  • keep the current web design
  • make the current web design more appealing
  • fix obvious design/UI/UX flaws
  • fix obviously wrong content
  • add or refresh content where necessary

How Has This Been Tested?

The edits have been manually tested on my local machine and the preview release (see above).

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation change

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation. Well, it is in fact the documentation itself ;-)
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have updated docs/changelog.md

Changes Details

  • link logo with homepage (better ux imho, and it is simply expected)
  • set overall line-height to 1.5 (more appealing)
  • fix all broken anchor links from menu and within content (this was annoying)
  • open all external links in a new tab (better ux imho)
  • in menu remove intendation of first level, add margin bottom to section (more space for 3rd level menu items)
  • reduce font size for code examples highlighted by prisma.js to same size as flems examples (so, font-sizes of normal preformated text, code examples and flems examples are the same size)
  • increase margin bottom for code examples to approx. 150% of p-tags (more appealing)
  • remove all "how to contribute" menu items und place it under the page as table of contents (those menu item link labels were way too long)
  • remove "code" formattings in table cells except for the description (makes it more readable)
  • for all backgrounds use a similar color tone, the one from prisma.js (so we have a simple color scheme)
  • made the hamburger a bit larger (better ux)
  • fixed z-index issue with flems example laying on top of the menu layer (obvious ux issue)
  • fixed issue with different line heights in paragraphs and other tags when using "code" tags (keep consistent line-height)
  • in prisma.js fixed wrong background color for operators (looks to me like a bug in prisma.js)
  • use "white-space:nowrap" and "text-overflow:ellipsis" for left menu items (more appealing, better readability)
  • remove weird looking link labels when using "code" within "a" tags (this was terrible, much better now with better readability)
  • remove weird looking link labels when using "code" within "a" within "h" tags (same as above)
  • add mouse-over for "a>code"-tag (makes it clearer that it is a link)
  • adjust indentation of ordered and unordered lists (better design and imho cleaner)
  • break line of very long <code> examples within p-tags on small screen (broke the layout)
  • remove link to "jsonp" page (page was removed at some point)
  • on small screen hide first ruler after h1 consequently (some pages have a ruler, some not, depending wether there are menu items for the page, unnecessary inconsistency)
  • cleanup header hierarchy on certain pages (code-of-conduct, contributing, integrating-libs, releasing)
  • add a propper 404 page (nicer for the visior, with additional help maybe)
  • remove all release candidate versions from the version selector (not needed, as each version can be accessed by entering the URL in the address bar)
  • remove Mithril.js Jobs from Misc section (linked wiki page is really outdated)
  • reordered the "Misc" section (more "logical" now)
  • move ES6+ on legacy browsers from Resources to Misc section (to make it less prominent)
  • move Learning Resources from Getting Started to Misc section (to make it less prominent)
  • remove v1 Documentation and v0.2 Documentation from Misc section (we have those links already in the version selector besides the logo, and we don't want to promote older versions, of course)
  • cleanup left menu items
  • Change footer "License: MIT. © Leo Horie." to something more appropriate (better and current information with link to community)
  • add sticky footer (looks better on pages with little content)
  • add smooth scroll behavior (it's nicer)
  • Missing page title in documentation #2833
  • Wrong archive links when already in archive #2832
  • remove "ES6+ on legacy browsers from menu (@modir). Instead removing we moved it to the misc section
  • slightly lighter base font color #181818 (looks lighter)
  • memorize scroll position of left column across page loads (better ux)
  • bump prism.js up to latest 1.29.0 version
  • make two col layout with 100% height and scrollbars (in progress)
  • add "two columns 100% height layout with scrollbars" like here: https://mithriljs.tebe.ch/draft-01/
  • version selector: all we really need is latest v1.x and latest v2.x. Not sure it's worth listing minor versions (@dead-claudia)

@tbreuss tbreuss changed the title fix: several css issues fix: several html & css issues May 1, 2023
Copy link
Member

@dead-claudia dead-claudia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment. Not sure the change is justified.

docs/contributing.md Outdated Show resolved Hide resolved
@tbreuss tbreuss marked this pull request as ready for review May 20, 2023 07:48
@tbreuss tbreuss changed the title fix: several html & css issues refresh web design, fix several html, css and content issues May 20, 2023
@tbreuss tbreuss changed the title refresh web design, fix several html, css and content issues docs: refresh web design, fix several html, css and content issues May 20, 2023
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.

None yet

2 participants