Refactor module references and update related documentation#1
Merged
rebelinux merged 4 commits intoAsBuiltReport:devfrom Mar 6, 2026
Merged
Refactor module references and update related documentation#1rebelinux merged 4 commits intoAsBuiltReport:devfrom
rebelinux merged 4 commits intoAsBuiltReport:devfrom
Conversation
- Changed module references from Diagrammer.Core to AsBuiltReport.Diagram in example scripts (Example16.ps1, Example17.ps1). - Updated license year from 2024 to 2026 in LICENSE file. - Corrected GitHub links in README.md to point to the new repository location. - Updated security documentation to reflect the correct module name. - Adjusted internal script documentation links to point to the new repository. - Removed mkdocs.yml as it is no longer needed. - Updated Graphviz source file paths to reflect the new module structure. - Modified test initialization script to reference the new module name.
…BuiltReport.Diagram
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the project from the Diagrammer.Core module identity to AsBuiltReport.Diagram, updating module metadata, examples, GitHub templates/workflows, and removing legacy MkDocs/documentation assets tied to the old module/repo.
Changes:
- Renamed/retargeted the PowerShell module manifest and related metadata/URLs to
AsBuiltReport.Diagram. - Updated example scripts and GitHub templates/workflows to reference the new module/repository.
- Removed legacy MkDocs workflow and a large set of documentation files/assets associated with
Diagrammer.Core.
Reviewed changes
Copilot reviewed 79 out of 142 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| Examples/Example01.ps1 | Updates module import comment to new module name. |
| Examples/Example02.ps1 | Updates module references to AsBuiltReport.Diagram. |
| Examples/Example03.ps1 | Updates module references and repo links. |
| Examples/Example04.ps1 | Updates module references and repo links. |
| Examples/Example05.ps1 | Updates module references and module naming in comments. |
| Examples/Example06.ps1 | Updates module references and repo links. |
| Examples/Example07.ps1 | Updates module references and repo links. |
| Examples/Example08.ps1 | Updates module references and repo links. |
| Examples/Example09.ps1 | Updates module references and repo links. |
| Examples/Example10.ps1 | Updates module references and repo links. |
| Examples/Example11.ps1 | Updates module references and repo links. |
| Examples/Example12.ps1 | Updates module references and repo links. |
| Examples/Example13.ps1 | Updates module references and repo links. |
| Examples/AdvancedExample01.ps1 | Updates module references and label text to new module naming. |
| Examples/AdvancedExample02.ps1 | Updates module references and label text to new module naming. |
| CHANGELOG.md | Renames changelog header and updates issue/repo links to the new repository. |
| AsBuiltReport.Diagram.psd1 | Renames manifest metadata and updates project/help URIs for the new module. |
| .github/workflows/Release.yml | Updates publish workflow to validate the renamed module manifest. |
| .github/workflows/MkDocs.yml | Removes MkDocs deployment workflow. |
| .github/PULL_REQUEST_TEMPLATE.md | Updates contributing link to new repository. |
| .github/ISSUE_TEMPLATE/change_request.yml | Updates issue template links to new repository. |
| .github/ISSUE_TEMPLATE/bug_report.yml | Updates bug template text/links to new module/repository. |
| Docs/start/limitations.md | Removes legacy limitations page tied to Diagrammer.Core docs. |
| Docs/start/introduction.md | Removes legacy introduction content tied to Diagrammer.Core docs. |
| Docs/start/installation.md | Removes legacy installation instructions for Diagrammer.Core. |
| Docs/index.md | Removes legacy docs landing page content for Diagrammer.Core. |
| Docs/help/support.md | Removes legacy support page referencing Diagrammer.Core. |
| Docs/help/faq.md | Removes legacy FAQ content referencing Diagrammer.Core. |
| Docs/dev-guide/examples/examples.md | Removes legacy examples index referencing Diagrammer.Core docs site. |
| Docs/dev-guide/examples/example1.md | Removes legacy Example 1 documentation page. |
| Docs/dev-guide/examples/example2.md | Removes legacy Example 2 documentation page. |
| Docs/dev-guide/examples/example3.md | Removes legacy Example 3 documentation page. |
| Docs/dev-guide/examples/example4.md | Removes legacy Example 4 documentation page. |
| Docs/dev-guide/examples/example6.md | Removes legacy Example 6 documentation page. |
| Docs/dev-guide/examples/example12.md | Removes legacy Example 12 documentation page. |
| Docs/dev-guide/commands/commands.md | Removes legacy cmdlet index referencing Diagrammer.Core docs. |
| Docs/dev-guide/commands/Get-RandomColorHex.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Get-RandomPastelColorHex.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Export-Diagrammer.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaVerticalLine.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaTShapeLine.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaRightLShapeLine.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaNodeText.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaNodeSpacer.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaNodeShape.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaNodeImage.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaLeftTShapeLine.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaLeftLShapeLine.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaLShapeLine.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaInvertedLShapeLine.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaHtmlSignatureTable.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaHorizontalLine.md | Removes legacy cmdlet doc page. |
| Docs/dev-guide/commands/Add-DiaHTMLLabel.md | Removes legacy cmdlet doc page. |
| Docs/assets/overrides/partials/comments.html | Removes legacy giscus comments partial referencing old repo. |
| Docs/assets/javascripts/tablesort.js | Removes legacy table-sorting script used by old docs. |
| Docs/about/todo.md | Removes legacy todo page embedding old repo content. |
| Docs/about/license.md | Removes legacy license page content from docs. |
| Docs/about/contact.md | Removes legacy contact page referencing old repo. |
| Docs/about/changelog.md | Removes legacy changelog embed pointing at old repo. |
| Docs/CNAME | Removes custom domain configuration for old docs site. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+101
to
+110
| LicenseUri = 'https://raw.githubusercontent.com/rebelinux/AsBuiltReport.Diagram/master/LICENSE' | ||
|
|
||
| # A URL to the main website for this project. | ||
| ProjectUri = 'https://github.com/rebelinux/Diagrammer.Core' | ||
| ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.Diagram' | ||
|
|
||
| # A URL to an icon representing this module. | ||
| IconUri = 'https://raw.githubusercontent.com/rebelinux/Diagrammer.Core/main/Icons/Diagrammer.png' | ||
| IconUri = 'https://raw.githubusercontent.com/rebelinux/AsBuiltReport.Diagram/main/Icons/Diagrammer.png' | ||
|
|
||
| # ReleaseNotes of this module | ||
| ReleaseNotes = 'https://github.com/rebelinux/Diagrammer.Core/blob/master/CHANGELOG.md' | ||
| ReleaseNotes = 'https://github.com/AsBuiltReport/AsBuiltReport.Diagram/blob/master/CHANGELOG.md' |
There was a problem hiding this comment.
The manifest metadata mixes different GitHub owners/orgs: ProjectUri/ReleaseNotes/HelpInfoURI point to AsBuiltReport/AsBuiltReport.Diagram, but LicenseUri and IconUri point to rebelinux/AsBuiltReport.Diagram. This is very likely to produce broken links in gallery metadata. Update LicenseUri and IconUri to use the same owner/org as ProjectUri (and keep branches consistent as well).
Collaborator
Author
There was a problem hiding this comment.
@copilot open a new pull request to apply changes based on this feedback
|
|
||
| # HelpInfo URI of this module | ||
| HelpInfoURI = 'https://github.com/rebelinux/Diagrammer.Core#readme' | ||
| HelpInfoURI = 'https://github.com/AsBuiltReport/AsBuiltReport.Diagram#readme' |
There was a problem hiding this comment.
The manifest metadata mixes different GitHub owners/orgs: ProjectUri/ReleaseNotes/HelpInfoURI point to AsBuiltReport/AsBuiltReport.Diagram, but LicenseUri and IconUri point to rebelinux/AsBuiltReport.Diagram. This is very likely to produce broken links in gallery metadata. Update LicenseUri and IconUri to use the same owner/org as ProjectUri (and keep branches consistent as well).
Collaborator
Author
There was a problem hiding this comment.
@copilot open a new pull request to apply changes based on this feedback
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 79 out of 142 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
This pull request makes a comprehensive transition from the
Diagrammer.Coremodule to the newAsBuiltReport.Diagrammodule. The changes include renaming files, updating references throughout documentation, templates, and workflows, and removing outdated or obsolete files. The update ensures consistency in naming, links, and branding across the project.Module migration and renaming:
Diagrammer.Core.psd1toAsBuiltReport.Diagram.psd1, updated theRootModule,GUID, and all associated metadata and links to reflect the new module name and repository. [1] [2] [3] [4]Diagrammer.Core ChangelogtoAsBuiltReport.Diagram Changelog, and revised all module and issue references within the changelog. [1] [2] [3] [4] [5] [6]Documentation and template updates:
bug_report.yml,change_request.yml), pull request template, and workflow files to use the new module and repository name. [1] [2] [3] [4] [5] [6] [7] [8]Removal of obsolete files and branding:
MkDocs.yml), CNAME configuration, and several documentation files and assets related to the old module, including changelog, contact, license, todo, tablesort script, and comments partial. [1] [2] [3] [4] [5] [6] [7] [8]