Skip to content

docs: add concepts section for outlining important OOB pieces#748

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

docs: add concepts section for outlining important OOB pieces#748
rsdmike merged 1 commit intomainfrom
concepts

Conversation

@rsdmike
Copy link
Member

@rsdmike rsdmike commented Feb 9, 2026

PR Checklist

What are you changing?

Creates a dedicated concept section to outline important aspects to understand as part of the toolkit. This declutters the "Reference" section a bit.

Anything the reviewer should know when reviewing this PR?

Copilot AI review requested due to automatic review settings February 9, 2026 20:38
@rsdmike rsdmike force-pushed the concepts branch 2 times, most recently from f61f00e to e8391de Compare February 9, 2026 20:41
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 the documentation by introducing a new Concepts section for key out-of-band (OOB) and foundational topics, reducing the amount of conceptual material living under Reference, and adding a Tutorials landing page to better orient users.

Changes:

  • Updates mkdocs.yml navigation to add a top-level Concepts section and a Tutorials > Overview entry.
  • Adds new Concepts pages (architecture, OOB management, control modes, security).
  • Streamlines Reference/architectureOverview.md by replacing large conceptual blocks with links to the new Concepts pages.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.

Show a summary per file
File Description
mkdocs.yml Adds the Concepts section and Tutorials overview to site navigation; removes duplicated “Get Help” blocks from other tabs.
docs/Tutorials/overview.md New Tutorials landing page with curated entry points and mkdocs-material button links.
docs/Reference/architectureOverview.md Refactors content to focus on architecture overview and links out to Concepts/Logging for deeper explanations.
docs/Concepts/architecture.md New architecture/concepts page consolidating deployment flow, components, and connection models.
docs/Concepts/oobManagement.md New OOB management concept page (in-band vs OOB, power control, KVM).
docs/Concepts/controlModes.md New ACM vs CCM control modes concept page plus domain profile notes and related links.
docs/Concepts/security.md New security overview page with credential guidance and links to component security/cert/secrets references.

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

@rsdmike rsdmike force-pushed the concepts branch 8 times, most recently from 8adcab4 to bb148e9 Compare February 9, 2026 21:50
@rsdmike rsdmike merged commit a15d292 into main Feb 9, 2026
3 checks passed
@rsdmike rsdmike deleted the concepts branch February 9, 2026 21:59
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