Skip to content

docs: consolidate Roadmap.md into Architecture and remove the root roadmap#234

Merged
SamErde merged 1 commit into
mainfrom
docs/consolidate-roadmap
Jun 2, 2026
Merged

docs: consolidate Roadmap.md into Architecture and remove the root roadmap#234
SamErde merged 1 commit into
mainfrom
docs/consolidate-roadmap

Conversation

@SamErde
Copy link
Copy Markdown
Owner

@SamErde SamErde commented Jun 2, 2026

What

Consolidates the root Roadmap.md into the docs and removes the standalone file, per the request to fold roadmap items into /docs where relevant and keep only the truly new items.

Per-item review

Already tracked or shipped — not re-added:

Roadmap item Disposition
Migrate to Microsoft.PowerShell.PlatyPS help generation Already in CHANGELOG.md [Unreleased]
List all installed modules that include MSAL Already ships as Get-ModulesWithVersionSortedIdentityClient (+ Get-ModulesWithDependency)
PowerShell 7.4+ compatibility/reliability Core ongoing purpose; documented (Architecture §2–§3, Deep-Dive)
Dependency lifecycle / supply-chain hardening Ongoing; documented (Architecture §8, Deep-Dive automation, dependency-policy.json, Upstream-Compatibility)

Truly new — added to docs/Architecture.md §9 as a "Planned feature enhancements (backlog)" list:

  • Import a specific version of MSAL on demand.
  • Verify a package's hash/signature against original source metadata before preload.
  • Option to preload additional (non-identity) common assemblies.
  • Option to preload only the newest relevant assemblies already installed on the system (inspection helpers exist; this adds the preload-from-installed mode).
  • A function to import a specific named set of assemblies.
  • A function to clean up older installed DLLPickle module versions.

Other changes

  • README.md "Project Documentation Map": repointed the Roadmap.md link to docs/Architecture.md (also adds the previously-missing Architecture blueprint link).
  • The historical CHANGELOG.md release note mentioning "README and Roadmap" is left intact.

Docs-only + root-file removal — no src//bundle change, so this does not trigger a release.

Fold the forward-looking roadmap into docs/ and drop the standalone root file.

Reviewed each roadmap item:
- Already tracked/done (NOT re-added): the Microsoft.PowerShell.PlatyPS help
  migration (CHANGELOG [Unreleased]); "list installed modules with MSAL"
  (ships as Get-ModulesWithVersionSortedIdentityClient / Get-ModulesWithDependency);
  PowerShell 7.4+ compatibility and dependency/supply-chain hardening (ongoing,
  documented in Architecture sections 3 and 8 and Deep-Dive).
- Truly new (added to Architecture section 9 "Known gaps / follow-ups" as a
  "Planned feature enhancements" backlog): import a specific MSAL version;
  verify package hash/signature vs source metadata; preload additional
  non-identity assemblies; preload-from-installed mode; import a named assembly
  set; clean up older installed DLLPickle versions.

Repoint the README "Project Documentation Map" entry from the removed
Roadmap.md to docs/Architecture.md (also adds the previously-missing
Architecture blueprint link). The CHANGELOG's historical "README and Roadmap"
release note is left intact.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 2, 2026 17:14
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 2, 2026
@codacy-production
Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Copy link
Copy Markdown
Contributor

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

Consolidates the previously root-level roadmap content into the existing documentation set by folding “planned enhancements” into docs/Architecture.md, and removes the standalone Roadmap.md file. This keeps roadmap/backlog items co-located with the architecture blueprint while preserving shipped/in-progress tracking in CHANGELOG.md.

Changes:

  • Removed the root Roadmap.md file.
  • Updated README.md to point “planned work” readers to docs/Architecture.md.
  • Added a “Planned feature enhancements (backlog)” list to docs/Architecture.md (with pointers back to CHANGELOG.md for shipped/in-progress work).

Reviewed changes

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

File Description
Roadmap.md Removes the root-level roadmap in favor of docs-based tracking.
README.md Repoints the “planned work” documentation map entry to the architecture blueprint.
docs/Architecture.md Adds a consolidated backlog list of planned enhancements formerly tracked in Roadmap.md.

@SamErde SamErde merged commit b7c71db into main Jun 2, 2026
16 checks passed
@SamErde SamErde deleted the docs/consolidate-roadmap branch June 2, 2026 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants