Skip to content

docs(compliments): fix remoteFile path after defaultmodules restructure#392

Open
Stordiau-P wants to merge 1 commit into
MagicMirrorOrg:developfrom
Stordiau-P:fix/compliments-remotefile-path
Open

docs(compliments): fix remoteFile path after defaultmodules restructure#392
Stordiau-P wants to merge 1 commit into
MagicMirrorOrg:developfrom
Stordiau-P:fix/compliments-remotefile-path

Conversation

@Stordiau-P

Copy link
Copy Markdown

Problem

The remoteFile documentation for the compliments module is out of date
following the April 2026 restructure that moved default modules from
modules/default/ to defaultmodules/ (announced here:
https://forum.magicmirror.builders/topic/20138/upcoming-release-april-1-2026-breaking-changes-some-operational-changes).

The current docs state:

  • The compliments module directory is modules/default/compliments/
  • A file placed in the MagicMirror root would be referenced as "../../compliments.json"

Both of these are now incorrect.

Changes

  1. Updated the module directory reference from modules/default/compliments/
    to defaultmodules/compliments/.
  2. Corrected the root-file example. Testing shows the MagicMirror root
    directory is not served statically by the webserver (confirmed via curl,
    see below), so the example now points to config/ instead, which is
    confirmed to work.

Testing

Verified manually against a clean v2.37.0 install:

Path tested remoteFile value Result
MagicMirror root ../../compliments.json 404 Not Found
MagicMirror root ../../../compliments.json 404 Not Found
config/ directory ../../config/compliments.json 200 OK
defaultmodules/compliments/ compliments.json 304 Not Modified (i.e. working, cached)

Related

Fixes the compliments module section referenced in
docs.magicmirror.builders/modules/compliments.html

- Update module directory reference from modules/default/compliments/
  to defaultmodules/compliments/
- Fix example: MagicMirror root is not served statically by the
  webserver, use config/ instead
- Verified with curl: root returns 404, config/ returns 200
@rejas

rejas commented Jul 4, 2026

Copy link
Copy Markdown
Collaborator

this should probably based against the master branch since this is a "live! issue?

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.

3 participants