Fixes #838 - docs: Move item types under reference documentation#976
Open
cmaneu wants to merge 1 commit into
Open
Fixes #838 - docs: Move item types under reference documentation#976cmaneu wants to merge 1 commit into
cmaneu wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request reorganizes the MkDocs documentation structure by introducing a dedicated Reference section and relocating “Item Types” and “Code Reference” content under it, while updating affected internal links and adding a changelog fragment for the docs change.
Changes:
- Updated
mkdocs.ymlnavigation to add a new “Reference” section and move “Item Types” + “Code Reference” under it. - Added
docs/reference/index.mdanddocs/reference/code_reference.mdto establish the new Reference landing page and API docs entry point. - Updated
docs/reference/item_types.mdlinks to correctly point back to the “How To” parameterization page.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Adds “Reference” to site navigation and relocates related pages under it. |
| docs/reference/item_types.md | Fixes relative links to parameterization content now that the page lives under reference/. |
| docs/reference/index.md | Introduces a landing page for the new Reference section with section TOC markers. |
| docs/reference/code_reference.md | Adds the mkdocstrings entry page for fabric_cicd under Reference. |
| .changes/unreleased/docs-20260506-134300.yaml | Adds a Changie docs fragment documenting the reorganization. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request reorganizes the documentation by moving the item type documentation from the "How To" section to a new "Reference" section. It also updates navigation and links to reflect this new structure, making it easier for users to find detailed reference material.
Linked Issue (REQUIRED)
#838