Skip to content

fix(docs): sync documentation by default#408

Merged
PrzemyslawKlys merged 2 commits into
mainfrom
fix/docs-update-by-default
May 28, 2026
Merged

fix(docs): sync documentation by default#408
PrzemyslawKlys merged 2 commits into
mainfrom
fix/docs-update-by-default

Conversation

@PrzemyslawKlys
Copy link
Copy Markdown
Member

@PrzemyslawKlys PrzemyslawKlys commented May 28, 2026

Summary

  • remove the legacy StartClean / UpdateWhenNew documentation switches, shared config properties, and schema entries
  • make enabled documentation generation always clean generated markdown, sync project docs, and preserve non-generated docs assets in both staging packages and project docs
  • preserve hand-authored markdown under docs folders while pruning stale PowerForge-generated markdown
  • avoid same-path absolute docs deletion, reject project-root docs paths before staging normalization, route safe project-root absolute docs paths through staging, and avoid docs cleanup before extraction succeeds
  • make the Step-Version Pester test independent of live PowerShell Gallery availability

Validation

  • dotnet test .\PowerForge.Tests\PowerForge.Tests.csproj -c Release --filter "DocumentationEngineSafetyTests|ModulePipelineDocumentationSyncTests|DocumentationConfigurationFactoryTests|ModulePipelineStepTests" --nologo
  • dotnet test .\PowerForge.Tests\PowerForge.Tests.csproj -c Release --filter "FullyQualifiedName~Documentation" --nologo
  • dotnet build .\PSPublishModule.sln -c Release --nologo
  • pwsh -NoProfile -ExecutionPolicy Bypass -Command "Import-Module Pester -MinimumVersion 5.0 -ErrorAction Stop; Invoke-Pester -Path '.\Module\Tests\Step-Version.Tests.ps1' -CI"
  • imported PSPublishModule\bin\Release\net8.0\PSPublishModule.dll and verified New-ConfigurationDocumentation has no StartClean / UpdateWhenNew parameters and the emitted BuildDocumentation config has no such properties
  • Module\Build\Build-Module.ps1 completed successfully; validation passed, with the existing project file-consistency warning on PSPublishModule.Tests.ps1 mixed line endings
  • git -c core.whitespace=cr-at-eol diff --check

@PrzemyslawKlys PrzemyslawKlys force-pushed the fix/docs-update-by-default branch from 74b0617 to 9e95859 Compare May 28, 2026 07:58
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9e95859db2

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread PSPublishModule/Cmdlets/NewConfigurationDocumentationCommand.cs
Comment thread PowerForge.PowerShell/Services/ModulePipelineRunner.Utils.cs Outdated
Comment thread PowerForge.PowerShell/Services/ModulePipelineRunner.Utils.cs Outdated
@PrzemyslawKlys PrzemyslawKlys force-pushed the fix/docs-update-by-default branch from 9e95859 to 136b17c Compare May 28, 2026 08:14
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 136b17cd25

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread PowerForge.PowerShell/Services/DocumentationEngine.cs Outdated
@PrzemyslawKlys PrzemyslawKlys force-pushed the fix/docs-update-by-default branch from 136b17c to dac1729 Compare May 28, 2026 08:34
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: dac1729395

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread PowerForge.PowerShell/Services/DocumentationEngine.cs Outdated
Comment thread PowerForge.PowerShell/Services/ModulePipelineRunner.Run.Phases.cs
Comment thread PowerForge.PowerShell/Services/DocumentationEngine.cs Outdated
@PrzemyslawKlys PrzemyslawKlys force-pushed the fix/docs-update-by-default branch from dac1729 to 930b568 Compare May 28, 2026 09:03
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 930b568f26

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread PowerForge.PowerShell/Services/ModulePipelineRunner.Utils.cs
Comment thread PowerForge.PowerShell/Services/DocumentationEngine.cs
@PrzemyslawKlys PrzemyslawKlys force-pushed the fix/docs-update-by-default branch from 930b568 to 48cc245 Compare May 28, 2026 09:25
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 48cc245b1e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread Schemas/powerforge.segments.schema.json
@PrzemyslawKlys PrzemyslawKlys force-pushed the fix/docs-update-by-default branch from 48cc245 to 52f7c0e Compare May 28, 2026 09:44
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 52f7c0eeb0

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread PowerForge.PowerShell/Services/DocumentationEngine.cs Outdated
Comment thread PowerForge.PowerShell/Services/ModulePipelineRunner.Utils.cs Outdated
@PrzemyslawKlys PrzemyslawKlys merged commit 1c2cf81 into main May 28, 2026
6 checks passed
@PrzemyslawKlys PrzemyslawKlys deleted the fix/docs-update-by-default branch May 28, 2026 10:44
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.

1 participant