Skip to content

fix(docs): set explicit download filename on catalogue index buttons#17

Merged
FullGas1 merged 1 commit into
masterfrom
develop
Jul 19, 2026
Merged

fix(docs): set explicit download filename on catalogue index buttons#17
FullGas1 merged 1 commit into
masterfrom
develop

Conversation

@FullGas1

@FullGas1 FullGas1 commented Jul 19, 2026

Copy link
Copy Markdown
Collaborator

Closes #11

Summary

  • CI copies .lua files to docs/downloads/ for same-origin download
  • Download buttons use download="plugin-name.lua" for correct filename
  • MkDocs hook (hooks.py) adds target="ext-{id}" rel="noopener" to all external links
  • CONTEXT.md and ADRs 0001-0003 migrated to English

Test plan

  • Verified on dev site: .lua download triggers file save with correct filename
  • Verified on dev site: mod button opens in new tab, reused on repeated clicks

Summary by Sourcery

Documentation:

  • Update catalogue index download buttons to use explicit filenames for Metal FARP Lua plugin downloads.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@FullGas1
FullGas1 merged commit 9c2cc5c into master Jul 19, 2026
6 checks passed
@sourcery-ai

sourcery-ai Bot commented Jul 19, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR ensures the Lua plugin download buttons in the docs trigger browser downloads with an explicit and correct filename, aligning the rendered HTML with the intended user-facing behavior. CI, external link handling, and documentation language migration are also adjusted per the description, though only the download attribute change is visible in the provided diff.

Sequence diagram for explicit download filename on Lua plugin button

sequenceDiagram
    actor User
    participant Browser
    participant DocsServer

    User->>Browser: click metal-farp.lua .md-button
    Browser->>DocsServer: GET /downloads/CTLD_metalFarpScene.lua
    DocsServer-->>Browser: 200 CTLD_metalFarpScene.lua
    Browser->>Browser: apply download attribute metal-farp.lua
    Browser-->>User: prompt save dialog with filename metal-farp.lua
Loading

File-Level Changes

Change Details Files
Ensure catalogue download buttons force a stable, explicit Lua filename when saving the file from the docs site.
  • Replace bare download attribute on the Metal FARP download link with an explicit download="metal-farp.lua" value.
  • Keep the underlying href pointing at the CI-populated downloads/CTLD_metalFarpScene.lua path while controlling the user-visible saved filename.
  • Apply the same explicit download filename behavior consistently in both the English and French catalogue index pages.
docs/index.md
docs/index.fr.md

Possibly linked issues


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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

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.

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