MagicMirrorOrg
Proposal: Wiki Restructure
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?
I think most of the content of the Wiki can be moved to the docs website. The 3rd Party Modules list is probably the only one that needs to remain in the Wiki and Mirror Vendor List, since this is a community driven list.
For all other aspects (installation, faq, etc) it makes more sense to put that all in one spot: the documentation page.
Whats your thought about that?
Yes, only the modules list (and the hw vendors) is something that has a real place here since they need to (and will) be updated often. So for the moduels maybe just seperate the one big page into subpages like finance etc, just like the voice modules already have a page?
Module development is a prime candidate for the docs indeed.
I wasnt very sure about the tips / tricks for installation, Some might already be outdated now, some might need more updates than on release day...
how about managing the 3th party modules in a json file in the repo and then include them into the docs with a very good customizable search which uses the json from the repo?
I mean something like that https://www.electronjs.org/apps
That sounds nice but would require a) someone to build something like this (could you?) b) that MichMich would have to approve and merge an PR for every change. Not sure if he would like that (or would delegate that work).
I once built a search engine for modules. The idea was that the community would help maintaining it. But in the end it was just yet one other thing for me to maintain and service. For now I prefer to just manage it in the Wiki.
If only it would be easy to build a pipeline like https://tiny-helpers.dev/ has... Not that I wouldnt find that a tempting task but I surely dont have the time for that :-D
I like the idea to have everything in the documentation page.
But I see no automated build process for the doc. We could leave the 3rd Party and Vendor List in a public repo and use an automated build (e.g. run weekly) for the doc stuff, where the 2 files are fetched and integrated in the doc.
The docs have an automated build process. As soon as I merge a change, the site will be updated.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
![stale[bot] avatar](https://avatars.githubusercontent.com/in/1724?v=4 "Published by a pub.dev verified publisher"){kind=small}
I'd rlike to e-open this since I might want to slowly cleanup the wiki. First target: Deletion of https://github.com/MichMich/MagicMirror/wiki/Running-Magic-Mi rror-on-OSX-(and-potentially-windows)
Doesn thave any real value here, what you think @MichMich ? It would be easy to just push the delete button but I want to check back with you.
First PR opened for some pages: https://github.com/MichMich/MagicMirror-Documentation/pull/87/files
When that gets merged following pages can be deleted in the wiki:
- https://github.com/MichMich/MagicMirror/wiki/Apple-Google-Microsoft-Calendar-Support
- https://github.com/MichMich/MagicMirror/wiki/Module-Debugging
- https://github.com/MichMich/MagicMirror/wiki/Notifications
- https://github.com/MichMich/MagicMirror/wiki/Auto-Starting-MagicMirror
THe other wiki pages about on how to configure MM on linux/pi will be cleaned up later. I propose to just add a how-to for the latest raspi-os version and remove all old OS tips, sicne most users would download the latest version anyway. Any comments about that @MichMich ?
I deleted the pages mentioned above since the PR putting them in the official documentation site is now merged.
As for the installation pages I was planning to do that during the xmas holidays but alas I dont find the time right now. Hopefully in january :-)
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.