Skip to content

📖 [Docs]: Process documentation publishes from Process-PSModule - #447

Merged
Marius Storhaug (MariusStorhaug) merged 14 commits into
mainfrom
migrate-process-docs
Aug 9, 2026
Merged

📖 [Docs]: Process documentation publishes from Process-PSModule#447
Marius Storhaug (MariusStorhaug) merged 14 commits into
mainfrom
migrate-process-docs

Conversation

@MariusStorhaug

@MariusStorhaugMarius Storhaug (MariusStorhaug) commented Aug 8, 2026

Copy link
Copy Markdown
Member

The Process-PSModule documentation will publish as a self-contained site from this repository at https://psmodule.io/docs/.

[process-docs-migration]

Changed:

  • Added all 53 authored Markdown pages, page assets, includes, navigation, Zensical configuration, consent/social settings, and Tablesort behavior under docs/.
  • Added the standalone Docs workflow to build the target site, upload a Pages artifact, and deploy only from main; it keeps source-equivalent manual, schedule, push, pull-request, concurrency, and PR Super-Linter behavior.
  • Added the GitHub App-authenticated dynamic module catalog action and all four catalog templates so it writes docs/content/Modules/Catalog/index.md.
  • Added the Process-PSModule workflow overview, specification, design, configuration, usage, pipeline, test-exception, and practices reference alongside the framework source.
  • Updated repository ownership, edit links, and the README documentation link for PSModule/Process-PSModule.
  • Disabled Giscus by omitting the source comment partial from the published site.

Technical Details

  • PSModule/docs remains unchanged; this pull request adds the target site without external repository changes.
  • The Process-PSModule specification, design, and runtime reference now live under docs/content/Modules/Process-PSModule/, including the workflow media. References to MSXOrg-wide standards remain canonical external links.
  • The generic repository Linter retains its existing public-class exclusion and excludes only the self-contained Docs scope: docs/**, .github/actions/update-index/**, and .github/workflows/Docs.yml. Biome's workspace configuration mirrors the docs and catalog-action exclusions; generic lint coverage is unchanged everywhere else.
  • The dedicated Docs workflow remains responsible for complete PR lint coverage of the site and its automation with source-equivalent rules, preventing unrelated artifact-pipeline rules from altering the authored corpus. Its pull-request paths explicitly include catalog-action changes so action-only PRs receive that coverage. Its Markdown profile permits the imported corpus's intentional compact and aligned table styles.
  • Removed the configuration references to missing extra.css, abbreviation-preview JavaScript, and includes/links.md so the target builds without dangling runtime references.
  • The catalog action retains the source ClientID and PrivateKey inputs and SCRIBBLER_BOT_CLIENT_ID / SCRIBBLER_BOT_PRIVATE_KEY secret names. Catalog regeneration runs only for trusted non-PR events on refs/heads/main; PR and branch-dispatched builds use authored documentation without passing secrets to checked-out action code. Non-PR publication requires only the successful Build job.
  • GitHub Pages is enabled for GitHub Actions. The https://psmodule.io/docs/ custom-domain/DNS cutover and live-site validation remain outstanding.

Related Issues

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actionsBot commented Aug 8, 2026

Copy link
Copy Markdown

Super-linter summary

LanguageValidation result
CHECKOVPass ✅
GITHUB_ACTIONSPass ✅
GITHUB_ACTIONS_ZIZMORPass ✅
GITLEAKSPass ✅
GIT_MERGE_CONFLICT_MARKERSPass ✅
HTMLPass ✅
JAVASCRIPT_ESPass ✅
JAVASCRIPT_PRETTIERPass ✅
MARKDOWNPass ✅
NATURAL_LANGUAGEPass ✅
POWERSHELLPass ✅
PRE_COMMITPass ✅
SPELL_CODESPELLPass ✅
TRIVYPass ✅
YAMLPass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review August 9, 2026 07:19
@MariusStorhaug
Marius Storhaug (MariusStorhaug) merged commit d1e2feb into mainAug 9, 2026
99 of 101 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the migrate-process-docs branch August 9, 2026 07:21
Marius Storhaug (MariusStorhaug) added a commit to MSXOrg/docs that referenced this pull request Aug 9, 2026
Process-PSModule guidance will use the canonical PSModule documentation
site, giving readers one authoritative reference once that site is
publicly available.
## Changed: Process-PSModule documentation reference
The MSX documentation navigation no longer publishes a separate local
Process-PSModule reference. Every remaining documentation reference
points to the canonical Process-PSModule documentation URL.
---
<details>
<summary>Technical details</summary>
- Removes `src/docs/Capabilities/process-psmodule/`, including its media
assets, and removes its Zensical navigation block.
- This pull request remains a draft and must merge only after
`PSModule/Process-PSModule#447` merges, its target Pages deployment
serves `https://psmodule.io/docs/Modules/Process-PSModule/`, and the
canonical links have been verified.
- Regenerates the Capabilities index and updates the PSModule
initiative, PowerShell on GitHub design, and PowerShell testing
references to the canonical URL.
- Standards alignment: documentation content and Zensical navigation are
aligned with the Documentation Model; no MSX-wide standards are changed.
</details>
<details>
<summary>Relevant issues (or links)</summary>
- PSModule/Process-PSModule#447
- PSModule/Process-PSModule#428
</details>
---------
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@MariusStorhaug