Skip to content

Commit 4a0714d

Browse files
Add reference to Deepwiki (#323)
* Add reference to Deepwiki * Update Deepwiki references to clarify AI origin
1 parent e331134 commit 4a0714d

File tree

4 files changed

+31
-0
lines changed

4 files changed

+31
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,16 @@ MagicMirror² focuses on a modular plugin system and uses
2727
[Electron](https://www.electronjs.org/) as an application wrapper. So no more
2828
web server or browser installs necessary!
2929

30+
## Further reading
31+
32+
Looking for a deeper understanding or a different perspective? Deepwiki offers a
33+
concise architecture map and cross‑repo insights that complement this
34+
documentation:
35+
[Deepwiki overview of MagicMirror](https://deepwiki.com/MagicMirrorOrg/MagicMirror/).
36+
37+
This independent, third-party, AI generated documentation and analysis is not
38+
authored by the MagicMirror team — use it with a critical eye.
39+
3040
<p style="text-align: center">
3141
<a href="https://forum.magicmirror.builders/topic/728/magicmirror-is-voted-number-1-in-the-magpi-top-50"><img src="https://magicmirror.builders/img/magpi-best-watermark-custom.png" width="150" alt="MagPi Top 50"></a>
3242
</p>

cspell.config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"version": "0.2",
33
"language": "en",
44
"words": [
5+
"Deepwiki",
56
"anyfileorfolder",
67
"apikey",
78
"Autorestart",

development/introduction.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,13 @@ same time.
6767
can be used by the core module script. For example:
6868
_modulename/css/modulename.css_ would be a good path for your additional
6969
module styles.
70+
71+
## Further reading
72+
73+
Deepwiki provides a complementary, high‑level view of MagicMirror — architecture
74+
map, component interactions, and codebase hot spots — it may help you to gain a
75+
deeper understanding, spot extension points, and debug faster. See the
76+
[Deepwiki overview of MagicMirror](https://deepwiki.com/MagicMirrorOrg/MagicMirror/).
77+
78+
This independent, third-party, AI generated documentation and analysis is not
79+
authored by the MagicMirror team — use it with a critical eye.

modules/introduction.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,13 @@ If you want to build your own modules, check out the
2121
and don't forget to add it to the
2222
[wiki](https://github.com/MagicMirrorOrg/MagicMirror/wiki) and the
2323
[forum](https://forum.magicmirror.builders/category/7/showcase)!
24+
25+
## Further reading
26+
27+
For a big‑picture view of how modules plug into the core (APIs, lifecycle,
28+
communication paths), see Deepwiki’s project overview — great for planning
29+
integrations and troubleshooting:
30+
[Deepwiki overview of MagicMirror](https://deepwiki.com/MagicMirrorOrg/MagicMirror/).
31+
32+
This independent, third-party, AI generated documentation and analysis is not
33+
authored by the MagicMirror team — use it with a critical eye.

0 commit comments

Comments
 (0)