Skip to content

rework website and move "demo" link to supported platforms#533

Merged
nschimme merged 3 commits into
MUME:masterfrom
nschimme:master
May 21, 2026
Merged

rework website and move "demo" link to supported platforms#533
nschimme merged 3 commits into
MUME:masterfrom
nschimme:master

Conversation

@nschimme
Copy link
Copy Markdown
Contributor

@nschimme nschimme commented May 21, 2026

Summary by Sourcery

Revamp the website’s entry points to emphasize a platform-agnostic “Get MMapper” flow, including web access, while improving accessibility and automated download recommendations.

New Features:

  • Add a Web platform entry point alongside desktop platforms for using MMapper in the browser.
  • Introduce keyboard-accessible skip-to-content navigation and ARIA attributes for main navigation and platform links.

Enhancements:

  • Generalize download recommendation highlighting to support both traditional downloads and platform links, with ChromeOS users guided specifically to the Web version.
  • Retitle platform-specific pages and homepage section from “Download” to “Get MMapper” and add concise guidance text for each OS page.
  • Improve styling and positioning of recommendation labels so they work consistently with platform links and existing buttons.

Documentation:

  • Update homepage and platform-specific docs to describe platform choices, including a recommended Flathub install for Linux and clearer install instructions for Windows and macOS.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 21, 2026

Reviewer's Guide

Reworks the website’s “Get MMapper” flow to emphasize platform-based entry (including a web demo), improves accessibility, and refactors download highlighting to reuse logic and support platform links and ChromeOS-specific recommendations.

File-Level Changes

Change Details Files
Extend download recommendation logic to support platform links and prefer web on ChromeOS while deduplicating recommendation markup creation.
  • Select both traditional download links and new platform links for recommendation processing.
  • Extract recommendation UI creation into a reusable addRecommendation helper that adds classes and a trailing span.
  • Tag platform links with data-platform and apply a special class for web recommendations and platform-specific styling.
  • Change ChromeOS behavior to only recommend the web platform and avoid recommending any other binaries.
  • Reuse addRecommendation for architecture-matching links instead of inlining DOM manipulation.
docs/assets/js/download-highlight.js
Rework landing page CTA from OS downloads to platform selection, surfacing the web demo and improving accessibility semantics.
  • Rename the main section from “Download MMapper” to “Get MMapper” and update its anchor for in-page navigation.
  • Introduce a prominent Web platform link pointing to the /demo/ route with proper ARIA labels and icons.
  • Update Windows, macOS, and Linux platform links to use platform-link class and add descriptive aria-labels.
  • Adjust global nav to remove the separate Demo and Download items and replace them with a single Get link targeting the new anchor.
docs/index.md
docs/_layouts/default.html
Improve overall accessibility and copy for platform-specific pages, including skip link navigation and clearer installation guidance.
  • Add a skip-to-content link before the main wrapper and give the an ARIA label and the an ID for better keyboard navigation.
  • Introduce CSS for the skip-link to keep it hidden until focused while ensuring visual prominence when active.
  • Retitle Windows, macOS, and Linux pages from “Download” to “Get” for consistency with the main page.
  • Clarify installation instructions on Windows, macOS, and Linux pages, including recommending the Microsoft Store and Flathub where appropriate, and adjust recommendation text placement on the Windows page.
docs/assets/css/style.css
docs/_layouts/default.html
docs/windows.md
docs/macos.md
docs/linux.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@nschimme nschimme merged commit bcd8fca into MUME:master May 21, 2026
19 checks passed
@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 25.36%. Comparing base (90eb09d) to head (ae664f2).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #533   +/-   ##
=======================================
  Coverage   25.36%   25.36%           
=======================================
  Files         519      519           
  Lines       43185    43185           
  Branches     4706     4706           
=======================================
  Hits        10952    10952           
  Misses      32233    32233           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

1 participant