MagicMirrorOrg / MagicMirrorOrg/MagicMirror

Proposal: Wiki Restructure

Open
#2,545 24 comments 0 reactions 2 assignees View on GitHub

@KristjanESPERANTO is already working on this.

Since May 23, 2026.

under development under investigation
Dominant language
JavaScript
Stars
23.9k
Forks
4.6k
Avg merge
17h 31m
Merged PRs (30d)
25

Description

Good morning

the WIKI could in my opinion use a little spring cleaning. All pages are on the same level without any structure.

In a first step I grouped them in three categories: Develop / Installation / Modules.

Then I created a custom sidebar with https://github.com/adriantanasa/github-wiki-sidebar/wiki so that those groups are in a tree structure.

I wouldnt and couldnt push such a change idrectly to the wiki git sicne only @MichMich has the rights for that so I created a repo where one can see these changes: https://github.com/rejas/MagicMirrorWiki

If you have more ideas on how to freshen up the wiki please tell so.

In my opinion it is THE place to look for modules and some tips & tricks that dont fit anywhere else. Or are there any other ideas on where to collect infos about modules?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.