Docfx docs

[andrew-welker]

This pull request reorganizes and updates the Essentials documentation to improve clarity, navigation, and maintainability. The main changes include restructuring documentation files into thematic subdirectories, updating links throughout the docs to reflect the new structure, and introducing a comprehensive guide for contributing new documentation. Additionally, minor improvements to the docFx configuration enhance the user experience.

Documentation structure and navigation improvements:

• Added a new guide, how-to-add-docs.md, detailing how to contribute documentation, including directory structure, file naming, content guidelines, and TOC management.
• Restructured documentation files into how-to/, usage/, and technical-docs/ subdirectories under docs/docs/, and updated internal links to match the new structure. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]

Content updates and enhancements:

• Revised the "Get Started" documentation to clarify prerequisites, build steps, and device interaction commands, making onboarding easier for new users.

Configuration improvements:

• Updated docfx.json to enable opening links in a new tab, improving navigation for users browsing the documentation site.

[Copilot]

Pull request overview

This PR reorganizes the DocFX documentation into clearer topical sections, updates internal links/TOC to match the new structure, and adds contributor guidance for adding new docs.

Changes:

• Restructured docs into docs/docs/how-to/, docs/docs/usage/, and docs/docs/technical-docs/ and updated cross-links accordingly.
• Added new usage/technical documentation pages (e.g., JoinMaps, GenericComm, DigitalInput/RelayOutput bridging).
• Updated DocFX configuration metadata and refreshed the “Get started” onboarding content.

Reviewed changes

Copilot reviewed 16 out of 30 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
docs/index.md	Updates landing page wording and points “Plugins” link to the new technical-docs location.
docs/docs/usage/Standalone-Use.md	Updates links to moved docs (Plugins + SIMPL bridging).
docs/docs/usage/SIMPL-Bridging-Updated.md	Updates links to moved “Feedback Classes”, “JoinMaps”, and architecture docs.
docs/docs/usage/RelayOutput.md	Adds a new RelayOutput bridging/how-to page.
docs/docs/usage/JoinMaps.md	Adds a new Join Maps concept/reference page for bridging.
docs/docs/usage/IR-Driver-Bridging.md	Adds a new IR driver bridging reference page.
docs/docs/usage/GenericComm.md	Adds a new GenericComm bridging/reference page.
docs/docs/usage/DigitalInput.md	Adds a new DigitalInput bridging/how-to page.
docs/docs/usage/Bridging-To-Hardware-Resources.md	Updates links to the new usage subdirectory structure.
docs/docs/toc.yml	Reworks DocFX TOC to reflect the new directory layout and navigation.
docs/docs/technical-docs/Supported-Devices.md	Adds a supported devices listing under technical docs.
docs/docs/technical-docs/Plugins.md	Adds/relocates the main plugin documentation under technical docs.
docs/docs/technical-docs/Glossary-of-Terms.md	Adds a glossary page under technical docs.
docs/docs/technical-docs/Feedback-Classes.md	Adds/relocates feedback documentation under technical docs.
docs/docs/technical-docs/Debugging.md	Adds/relocates debugging documentation under technical docs.
docs/docs/technical-docs/Connection-Based-Routing.md	Adds/relocates connection-based routing documentation under technical docs.
docs/docs/technical-docs/ConfigurationStructure.md	Adds/relocates configuration structure documentation under technical docs.
docs/docs/technical-docs/Communication-Basics.md	Adds/relocates communication basics documentation under technical docs.
docs/docs/technical-docs/Arch-topics.md	Adds/relocates architecture topics documentation under technical docs.
docs/docs/technical-docs/Arch-summary.md	Updates “Next” link to point to the relocated architecture docs.
docs/docs/technical-docs/Arch-lifecycle.md	Updates architecture lifecycle navigation links for new locations.
docs/docs/technical-docs/Arch-activate.md	Updates connection-based routing and “Next” links for new locations.
docs/docs/technical-docs/Arch-1.md	Updates activation/lifecycle navigation links for new locations.
docs/docs/how-to/how-to-add-docs.md	Adds a how-to guide for contributing documentation and maintaining the TOC.
docs/docs/SIMPL-Bridging.md	Updates the “out of date” notice to point to the relocated updated SIMPL bridging doc, plus other moved links.
docs/docs/SIMPL-Bridging-Deprecated.md	Updates moved links (Feedback Classes, architecture).
docs/docs/Plugins-Deprecated.md	Updates the “Plugins” link to the relocated technical doc.
docs/docs/Home.md	Updates “Plugins” link to the relocated technical doc.
docs/docs/Get-started.md	Refreshes onboarding steps, prerequisites, and points next link to relocated Standalone Use doc.
docs/docfx.json	Adds DocFX global metadata intended to open links in a new tab.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The prerequisites mention the “.NET 9 SDK” and claim it will build a .NET Framework 4.7.2 (net472) project “with the appropriate references”. The repo targets net472 (see src/PepperDash.Essentials/PepperDash.Essentials.csproj), and building .NET Framework projects typically requires the .NET Framework Developer Pack/targeting pack on Windows. Please adjust prerequisites/instructions so they accurately reflect what’s required to build from source.

Suggested change

	* [.NET 9 SDK](https://dotnet.microsoft.com/en-us/download)
	* [Git](https://git-scm.com/)
	> Note: Essentials 2.x.x uses .NET Framework 4.7.2 currently. The .NET 9 SDK will build the project with the appropriate references
	* [.NET SDK 9.x or later](https://dotnet.microsoft.com/en-us/download) (for the `dotnet` CLI and tooling)
	* [.NET Framework 4.7.2 Developer Pack / targeting pack (Windows)](https://dotnet.microsoft.com/en-us/download/dotnet-framework/net472) (required to build `net472` projects)
	* [Git](https://git-scm.com/)
	> Note: Essentials 2.x.x targets .NET Framework 4.7.2. To build from source on Windows you must have the .NET Framework 4.7.2 Developer Pack/targeting pack installed in addition to the .NET SDK so that the correct .NET Framework reference assemblies are available to `dotnet build`.

[Copilot]

Branding typo: Github → GitHub.

Suggested change

	The latest release can be found on [Github](https://github.com/PepperDash/Essentials/releases/latest)
	The latest release can be found on [GitHub](https://github.com/PepperDash/Essentials/releases/latest)

[Copilot]

The TOC top-level entries are split into separate list items (e.g., one item has only name, the next only href). DocFX TOC nodes are expected to be single mapping objects (e.g., - name: ...\n href: ...\n items: ...), so this structure will likely produce broken/blank navigation items. Combine name/href into the same node and nest child pages under items:.

[Copilot]

The ordered list under “How to Get Started” starts at 2. and skips numbers (4. → 6.). While Markdown may auto-renumber, this is confusing in raw form and easy to misread when editing. Consider using 1. for each item (Markdown auto-numbering) or fix the sequence.

Suggested change

	2. Using an SFTP client or Crestron Toolbox, load the downloaded (or built) cpz to the processor in program slot 1
	1. If using SFTP, connect via SSH and start the program by sending console command `progload -p:1`
	3. On first boot, the Essentials Application will build the necessary configuration folder structure in the user/program1/ path.
	4. The application has some example configuration files included. Copy `/Program01/Example Configuration/EssentialsSpaceHuddleRoom/configurationFile-HuddleSpace-2-Source.json` to the `/User/Program1/` folder.
	6. Reset the program via console `progreset -p:1`. The program will load the example configuration file.
	1. Using an SFTP client or Crestron Toolbox, load the downloaded (or built) cpz to the processor in program slot 1
	1. If using SFTP, connect via SSH and start the program by sending console command `progload -p:1`
	2. On first boot, the Essentials Application will build the necessary configuration folder structure in the user/program1/ path.
	3. The application has some example configuration files included. Copy `/Program01/Example Configuration/EssentialsSpaceHuddleRoom/configurationFile-HuddleSpace-2-Source.json` to the `/User/Program1/` folder.
	4. Reset the program via console `progreset -p:1`. The program will load the example configuration file.

[Copilot]

The TOC entry uses how-to/How-to-add-docs.md, but the file on disk is how-to/how-to-add-docs.md (different casing). This will break links/builds on case-sensitive filesystems. Update the href to match the actual filename casing.

Suggested change

	href: how-to/How-to-add-docs.md
	href: how-to/how-to-add-docs.md