Skip to content

refactor: Refactored the PowerShell documentation build process into modular scripts#536

Draft
VaclavElias wants to merge 3 commits into
stride3d:masterfrom
VaclavElias:refactor-script-improvements
Draft

refactor: Refactored the PowerShell documentation build process into modular scripts#536
VaclavElias wants to merge 3 commits into
stride3d:masterfrom
VaclavElias:refactor-script-improvements

Conversation

@VaclavElias

Copy link
Copy Markdown
Contributor

Important

Merge after 4.4 release.

PR Classification

Code cleanup and documentation update to modularize and clarify the PowerShell documentation build pipeline.

PR Summary

Refactored the PowerShell documentation build process into modular scripts for better maintainability and future C# migration, and updated related documentation to reflect the new structure.

  • BuildDocs.ps1: refactored to dot-source new helper scripts, centralize settings, and orchestrate the build using modular functions.
  • build/ folder: added separate scripts for settings, language handling, console UI, file utilities, DocFX invocation, architecture docs import, post-processing, and per-language build steps, each with detailed comments and SYNOPSIS blocks.
  • documentation-generation-pipeline.md: updated to describe the modular script structure, clarify workflow, and revise diagrams and step names.

- BuildDocs.ps1: delegate steps to new build/ scripts (Settings, Languages, ConsoleUI, FileUtility, DocFx, ArchitectureDocs, PostProcessing, Build)
- Centralize paths, filenames, and tokens in Settings.ps1
- Unify interactive prompts and language selection logic
- Move architecture docs import and TOC generation to ArchitectureDocs.ps1
- Move per-language build logic to Build.ps1 (overlays, warning banners)
- Move DocFX invocation and API metadata to DocFx.ps1
- Move post-processing (docurl, sitemap, 404, deployment extras) to PostProcessing.ps1
- Add FileUtility.ps1 for path and file helpers
- Add Languages.ps1 for language utilities
- Update documentation-generation-pipeline.md for new structure
@VaclavElias VaclavElias added the site-generator Static site generator label Jul 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

site-generator Static site generator

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant