docs: add Host Configuration landing page - #755
Conversation
Add docs/Reference/Host-Configuration/Host-Configuration.md as an overview/landing page for the Host Configuration reference section, and switch the section's _category_.json link from generated-index to a doc link (matching Development/Contributing). Overview covers document structure, validation via `trident validate`, and how install/update servicing types are selected, with links into the Explanation docs for deeper detail.
|
Azure Pipelines: 1 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
There was a problem hiding this comment.
Pull request overview
Adds a new landing/overview doc for the Host Configuration reference section and updates the sidebar category to point at it, providing a clearer entry point into the generated schema reference and related explanatory docs.
Changes:
- Add
Host-Configuration.mdas an overview/landing page with pointers to the API reference, samples, validation, and servicing behavior. - Switch
docs/Reference/Host-Configuration/_category_.jsonfrom a generated index to adoclink targeting the new landing page.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/Reference/Host-Configuration/Host-Configuration.md | New landing page introducing Host Configuration structure, validation, and how Trident uses it. |
| docs/Reference/Host-Configuration/category.json | Updates the category link to use the new landing page as the section entry point. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (2)
docs/Reference/Host-Configuration/Host-Configuration.md:3
- This file appears to be committed with CRLF line endings (each line ends with a '\r'), while nearby docs files use LF. This makes future diffs noisy and can break formatting/linting tools that assume LF.
Suggestion: convert this file to LF (Unix) line endings before committing (e.g., re-save with LF or run a renormalization).
---
sidebar_position: 0
---
docs/Reference/Host-Configuration/category.json:5
- This JSON file is now using CRLF line endings (visible as '\r' at end of lines) whereas other docs JSON files in the repo use LF. Keeping LF avoids churn in diffs and prevents platform-specific formatting issues.
Suggestion: convert this file to LF line endings before committing.
{
"label": "Host Configuration",
"position": 1,
"link": {
"type": "doc",
Adds
docs/Reference/Host-Configuration/Host-Configuration.mdas an overview/landing page for the Host Configuration reference section._category_.jsonlink fromgenerated-indexto adoclink pointing at the new page (same pattern asDevelopment/Contributing).trident validate, and how install/update servicing types are selected, with links into the Explanation docs for deeper detail.Verified with
make website-build(Node 20) — builds clean with no broken links/anchors.