⚙️ [Maintenance]: Minor docs-site switch to Zensical#403
Open
Marius Storhaug (MariusStorhaug) wants to merge 13 commits into
Open
⚙️ [Maintenance]: Minor docs-site switch to Zensical#403Marius Storhaug (MariusStorhaug) wants to merge 13 commits into
Marius Storhaug (MariusStorhaug) wants to merge 13 commits into
Conversation
Remove mkdocs fallback from Build-Site, delete mkdocs fixture configs, and keep zensical.toml as the sole documentation configuration contract. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Remove unsupported --site-dir flag, inject site_dir into zensical.toml when absent, and assert ../../_site output exists for Pages artifact upload. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Set zensical site_dir to _site in generated config, move built output to ../../_site for artifact upload, and keep Build-Site output contract intact. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Replace missing Helpers module imports with PSModule in publish and prerelease-cleanup actions. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Inject a centralized nav-state script into generated site HTML during Build-Site so first-level menu defaults and persisted fold state are applied for all repositories using Process-PSModule. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Replace indented here-string with inline JavaScript string assignment so the workflow YAML parses correctly while retaining central nav-state injection. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Move long inline PowerShell from Build-Site into a dedicated local action with src/inject-site-scripts.ps1, and switch to folder-based site injector scripts under .github/scripts/site-injectors/. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Move every multiline run/Script step in Build-Site into internal composite actions with src scripts: Install-Zensical, Structure-Site, Build-ZensicalSite, and keep Inject-SiteScripts as action-backed invocation. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Replace remaining multiline run blocks in internal action.yml files with single-line invocations or commands, keeping executable logic in src scripts for better tooling and lint support. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
| run: | | ||
| # Build-PSModule | ||
| ${{ github.action_path }}/src/main.ps1 | ||
| run: ${{ github.action_path }}/src/main.ps1 |
| run: | | ||
| # Cleanup prerelease tags | ||
| ${{ github.action_path }}/src/cleanup.ps1 | ||
| run: ${{ github.action_path }}/src/cleanup.ps1 |
| run: | | ||
| # Build-PSModuleDocumentation | ||
| ${{ github.action_path }}/src/main.ps1 | ||
| run: ${{ github.action_path }}/src/main.ps1 |
| run: | | ||
| # Install-PSModule | ||
| ${{ github.action_path }}/src/main.ps1 | ||
| run: ${{ github.action_path }}/src/main.ps1 |
| run: | | ||
| # Resolve module version | ||
| ${{ github.action_path }}/src/main.ps1 | ||
| run: ${{ github.action_path }}/src/main.ps1 |
| run: | | ||
| # Get test paths | ||
| ${{ github.action_path }}/src/main.ps1 | ||
| run: ${{ github.action_path }}/src/main.ps1 |
Apply MSXOrg/docs standards to newly introduced internal actions: use consistent src/main.ps1 entry points, add PowerShell script headers/cmdlet binding, and add action README documentation for discoverability and reuse. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
| steps: | ||
| - name: Install Zensical CLI | ||
| shell: pwsh | ||
| run: '& "${{ github.action_path }}/src/main.ps1"' |
Add comment-based help blocks and inline parameter documentation to new action PowerShell entry scripts to align with MSXOrg/docs script standards. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
| shell: pwsh | ||
| env: | ||
| INPUT_WORKING_DIRECTORY: ${{ inputs.WorkingDirectory }} | ||
| run: '& "${{ github.action_path }}/src/main.ps1" -WorkingDirectory "$env:INPUT_WORKING_DIRECTORY"' |
| env: | ||
| INPUT_SITE_PATH: ${{ inputs.SitePath }} | ||
| INPUT_WORKFLOW_PATH: ${{ inputs.WorkflowPath }} | ||
| run: '& "${{ github.action_path }}/src/main.ps1" -SitePath "$env:INPUT_SITE_PATH" -WorkflowPath "$env:INPUT_WORKFLOW_PATH"' |
| env: | ||
| INPUT_WORKING_DIRECTORY: ${{ inputs.WorkingDirectory }} | ||
| INPUT_NAME: ${{ inputs.Name }} | ||
| run: '& "${{ github.action_path }}/src/main.ps1" -WorkingDirectory "$env:INPUT_WORKING_DIRECTORY" -Name "$env:INPUT_NAME"' |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Marius Storhaug (MariusStorhaug)
changed the title
Marius Storhaug (MariusStorhaug)
changed the title
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
2 participants
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 PR finalizes the documentation pipeline as a clean-cut Zensical implementation and removes legacy Material/MkDocs fallback behavior.
Changed: Build-Site now runs as Zensical-only
Build-Siteresolves site configuration fromzensical.tomland no longer uses MkDocs compatibility paths.Changed: Workflow logic moved to internal actions
Multi-line workflow scripts were extracted into internal composite actions with script files in
src/so workflow behavior stays code-backed and toolable.Changed: Shared site script injection is centralized
Navigation-state behavior is injected from framework-owned script files, replacing repo-local inline payload patterns.
Technical Details
.github/scripts/site-injectors/.Validation
GITHUB_ACTIONS_ZIZMOR,BIOME_LINT, andJAVASCRIPT_PRETTIER.MariusStorhaug/MariusTestModulewith a merged follow-up (#56) and successful PR/main workflow runs.