Skip to content

Commit d1e2feb

Browse files
📖 [Docs]: Process documentation publishes from Process-PSModule (#447)
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 - Parent: #423 - Documentation site: #426 - Live-site validation: #428 --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent bf67cd9 commit d1e2feb

88 files changed

Lines changed: 5597 additions & 3 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Update index
2+
description: Run repository index update script via GitHub-Script.
3+
inputs:
4+
ClientID:
5+
description: GitHub App client ID used by GitHub-Script.
6+
required: true
7+
PrivateKey:
8+
description: GitHub App private key used by GitHub-Script.
9+
required: true
10+
runs:
11+
using: composite
12+
steps:
13+
- name: Update index
14+
uses: PSModule/GitHub-Script@8083ec1f733f00357ee4d0db0c6056686e483bc0 # v1.9.0
15+
with:
16+
ClientID: ${{ inputs.ClientID }}
17+
PrivateKey: ${{ inputs.PrivateKey }}
18+
Script: |
19+
${{ github.action_path }}/src/main.ps1

0 commit comments

Comments
 (0)