Skip to content

docs: add section overviews#750

Merged
rsdmike merged 1 commit intomainfrom
overviews
Feb 9, 2026
Merged

docs: add section overviews#750
rsdmike merged 1 commit intomainfrom
overviews

Conversation

@rsdmike
Copy link
Member

@rsdmike rsdmike commented Feb 9, 2026

PR Checklist

What are you changing?

Anything the reviewer should know when reviewing this PR?

Copilot AI review requested due to automatic review settings February 9, 2026 21:56
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR reorganizes and expands the MkDocs documentation structure by introducing a new Concepts section and adding section-level overview pages, while updating multiple cross-references to match the new information architecture.

Changes:

  • Add new Concepts pages (Architecture, OOB Management, Control Modes, Security) and expose them in mkdocs.yml.
  • Add Tutorials Overview page and update entrypoints (site index + nav) to route users through it.
  • Refactor and re-link existing docs to point to the new Concepts content (notably around provisioning certificates and password/security guidance).

Reviewed changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
mkdocs.yml Adds Concepts to nav, adds Tutorials Overview, removes duplicate “Get Help” sections and prunes stale cert doc entry.
docs/videos.md Updates provisioning certificate link target; contains a now-broken passwords anchor reference.
docs/index.md Updates Tutorials CTA link to the new Tutorials overview page.
docs/Tutorials/overview.md New landing page organizing tutorials by theme with buttons/links.
docs/Reference/architectureOverview.md Replaces detailed sections with a shorter overview + “Learn More” links into Concepts.
docs/Reference/RPC/transitionDeviceRPC.md Updates passwords guidance link to new Security Overview.
docs/Reference/RPC/overview.md Reworks version guidance into an admonition + comparison table.
docs/Reference/Certificates/tls.md Updates Remote Provisioning link to new Concepts page.
docs/Reference/Certificates/generateProvisioningCert.md Updates vendor link to new Concepts Remote Provisioning “Purchase” section.
docs/Reference/Certificates/enrollCustomCertAMT.md Updates vendor link to new Concepts Remote Provisioning “Purchase” section.
docs/GetStarted/overview.md Adds Cloud vs Enterprise comparison table to guide path selection.
docs/GetStarted/Enterprise/manageDevice.md Expands “Next steps” into structured resource sections + buttons.
docs/GetStarted/Enterprise/createProfileCCM.md Updates passwords guidance link to new Security Overview.
docs/GetStarted/Enterprise/createProfileACM.md Updates provisioning cert + passwords guidance links to Concepts.
docs/GetStarted/Cloud/manageDevice.md Fixes a malformed “..\assets” phrase and adds Deployment + MQTT next steps.
docs/GetStarted/Cloud/loginToUI.md Updates provisioning certificate link target (but introduces broken/incorrect HTML links).
docs/GetStarted/Cloud/createProfileCCM.md Updates passwords guidance link to new Security Overview.
docs/GetStarted/Cloud/createProfileACM.md Updates provisioning cert + passwords guidance links to Concepts.
docs/Deployment/overview.md Adds a Scaling & Infrastructure section linking to scaling overview.
docs/Concepts/security.md New Security Overview page consolidating creds/certs/security links.
docs/Concepts/remoteProvisioning.md Re-formats Remote Provisioning concept content and fixes several internal paths.
docs/Concepts/oobManagement.md New OOB Management concept overview page.
docs/Concepts/controlModes.md New Control Modes (ACM/CCM) concept overview page.
docs/Concepts/architecture.md New Architecture & Components concept overview page.
Comments suppressed due to low confidence (2)

docs/Concepts/remoteProvisioning.md:6

  • This page starts with multiple blank lines and begins at an H2 ("## What is remote provisioning?"). Add a single H1 at the top (e.g., "# Remote Provisioning") and shift subsequent sections down one level so the page renders consistently with the other new Concepts pages and has a clear title.
    docs/Concepts/remoteProvisioning.md:24
  • The bullet * **A provisioning certificate*:** has mismatched emphasis markers (extra *), which will render incorrectly. Fix the markdown so the term is bolded without stray italics markers.

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

@rsdmike rsdmike enabled auto-merge (squash) February 9, 2026 22:10
@rsdmike rsdmike merged commit 4ce25ea into main Feb 9, 2026
3 checks passed
@rsdmike rsdmike deleted the overviews branch February 9, 2026 22:11
github-actions bot pushed a commit that referenced this pull request Feb 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants