Skip to content

Updates to Navigation#27

Open
samheckle wants to merge 4 commits into
mainfrom
nav-updates
Open

Updates to Navigation#27
samheckle wants to merge 4 commits into
mainfrom
nav-updates

Conversation

@samheckle

Copy link
Copy Markdown
Contributor

Related to #24 , first pass at navigation updates and some simplification on UI.

Changes made:

  • in contributing.md added some styling to hide the TOC from showing in navigation. This is an ugly solution and I'm not happy about it. But integrated TOC can't be hidden otherwise. We could change our writing of Markdown to not use headers, but that doesn't make sense.
  • added some more files in overrides/ to adjust for some styling updates
  • added new extensions and features in mkdocs.yml. Nothing actually needed to be installed, have yet to do research on actual impact of site size and something to check.
    • new extensions allow for ability for collapsible tabs for download page
    • new features change the way the navigation bar looks
  • updated some general copy (editing for repetition and such)

Note: my auto-formatter changed markdown files from * to _, and also made changes to extra.css. I will clean this up but not right now.

@samheckle samheckle requested a review from lee2sman June 4, 2026 08:01
@lee2sman

lee2sman commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

Thanks, great start on addressing the site usability.

Big question: Are these the right top level categories?

Categories are hard! I relooked at Processing.org catgories and find that organization confusing. In contrast the the p5.js website is better. I also like hydra categories. I know we' looked at all of these previously. now i'm relooking just for category names and hierarchy.

Download, Examples, and Tutorials are no longer top level categories. does that make them harder to find? From the Advanced users usability study (see page 23) they had top level sections as an example: Getting Started, Learning Resources, Reference, Contribution, and Developer Resources . Should our top section be named L5, Welcome, Intro, Home, or About?? I'm not sure what's best.

Immediate thoughts of improvements:

  • consolidate : I think the currently titled About section and Contributing belong in the same top level bucket so i think move everything in About under Contributing probably. The name About used here is confusing since it's really specifically on how L5 functions under the hood.
  • external site icon/indicator : Since the blog is our externally hosted L5 Devlog on Itch, maybe there should be a small icon that indicates it's taking you to an external site. Maybe a SVG icon? Although i have tested the symbol for example and seems to work everywhere for me, including dillo, netsurf and text browsers links and w3m. Tested via my site ➘Dig Archive.
  • Forum : i don't think this should be under contributing. Forum is a place to get help. Should it be a top level category? or under Learn? it should have the icon to show it links to an external site.

@lee2sman

lee2sman commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

Visual tests passed or no worse than previous site when tested across browsers. Updates tested on Firefox and the low bandwidth GUI browsers netsurf and dillo seemed to work well enough, to me, except for external itch hosted devlog was a little glitchy. In text browsers links, w3m worked well for new site design. In offpunk the navbar still missing, but that's a result of 'usability' library that's part of it optionally.

@lee2sman

lee2sman commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

Wrong asset image files linked on the mac install tutorial. file names should be mac1.webp to mac9.webp not for example mac2test.webp

@lee2sman

lee2sman commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

typos:

  • on download/index page: game engine name should be spelled Godot not Gadot
  • LÖVE or Love2d but never LOVE2D
  • Let's use * for bullet points (this isn't a typo but rather just trying to pick one to use consistently)
  • there's still extraneous underlines on a few pages

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.

2 participants