9a0118c603e8a773ca468c2382204e475e5bf7d4

Author
Zach White <skullydazed@gmail.com>
Committer
GitHub <noreply@github.com>
Date

Message

Architecture documentation for Configurator and API (#13935)

* Architecture documentation for the configurator and api

* Apply suggestions from code review

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

Diff

This diff is truncated to protect this page.

 1diff --git a/docs/_summary.md b/docs/_summary.md
 2index 9798ef5127d0e8130513e19da9bf0e6da9a13045..8347805a2fee9a50af1ea4fb7e82fa20fd7947fb 100644
 3--- a/docs/_summary.md
 4+++ b/docs/_summary.md
 5@@ -19,6 +19,7 @@
 6   * [Overview](newbs_building_firmware_configurator.md)
 7   * [Step by Step](configurator_step_by_step.md)
 8   * [Troubleshooting](configurator_troubleshooting.md)
 9+  * [Architecture](configurator_architecture.md)
10   * QMK API
11     * [Overview](api_overview.md)
12     * [API Documentation](api_docs.md)
13diff --git a/docs/configurator_architecture.md b/docs/configurator_architecture.md
14new file mode 100644
15index 0000000000000000000000000000000000000000..0d7fc8a73b4f1e06a78c5217700214db8854a473
16--- /dev/null
17+++ b/docs/configurator_architecture.md
18@@ -0,0 +1,61 @@
19+# QMK Configurator Architecture
20+
21diff --git a/docs/configurator_diagram.drawio b/docs/configurator_diagram.drawio
22new file mode 100644
23index 0000000000000000000000000000000000000000..091a3a76b8c35170033b413ea9c1feb9b820d494
24--- /dev/null
25+++ b/docs/configurator_diagram.drawio
26@@ -0,0 +1 @@
27diff --git a/docs/configurator_diagram.svg b/docs/configurator_diagram.svg
28new file mode 100644
29index 0000000000000000000000000000000000000000..bcf0bf76d1ec75550c12aefe69bcc5d906b1336b
30--- /dev/null
31+++ b/docs/configurator_diagram.svg
32@@ -0,0 +1,3 @@
33+<?xml version="1.0" encoding="UTF-8"?>
34+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">