Skip to content

Commit aa89bbe

Browse files
📖 [Docs]: Process-PSModule documentation is now organized by task (#448)
The Process-PSModule documentation now leads with how to use the pipeline. Getting started, guides, reference, and specification are separate sections, so someone looking up a setting or wiring up their first module no longer has to read the specification and design first. ## New: A guided path from template to first release Getting started is now a walkthrough rather than a single page of bullets. It covers creating the repository from the template, configuring GitHub Pages and the PowerShell Gallery API key, adding the caller workflow and settings file, and then opening the first pull request and applying a version label. Bootstrapping a brand-new module with an integration branch sits alongside it. ## New: Guides for the things people actually do Seven task-oriented pages cover calling the workflow, configuring the pipeline with worked examples, structuring a module, writing module tests, skipping individual framework tests, versioning and releases, and validating a change before review. Writing module tests is new — test discovery rules, the `BeforeAll.ps1` and `AfterAll.ps1` phases, and how to share expensive infrastructure across the platform matrix were previously buried inside the pipeline-stages page. ## Changed: Documentation is grouped by what you are trying to do The section was a flat list of 15 sibling pages ordered specification, design, usage. It is now four ordered sections: | Section | Purpose | | --- | --- | | Get started | Create a repository, configure it, ship a first release | | Guides | Task-oriented deep dives into the pipeline's functionality | | Reference | Exact contracts — settings, workflow inputs, stages, matrices, test IDs | | Specification | Spec, design, and principles, for maintainers of the pipeline itself | The specification and design are still published, just last, since few readers need them to use the pipeline. ## Changed: Every fact has one home The scenario matrix, the version-label mapping, the framework test IDs, the runtime settings contract, the repository setup steps, and the dependency list were each documented in two or three places. Each now lives on one page and is linked from the others, so they can no longer drift apart. The landing page also no longer prints the same page-index table twice. ## Changed: Pointer-only pages are gone The `PowerShell`, `Solutions`, and `Style-Guides` sections contained nothing but links to MSXOrg docs. They are removed and the pages that referenced them now link straight to the canonical MSX standards, removing a hop. --- <details> <summary>Technical details</summary> - All page moves use `git mv`, so file history follows the content. - Merges and splits: `index.md` + `workflow-overview.md` → one landing page; `module-anatomy.md` folded into `guides/structuring-your-module.md`; the `build-test-pack-publish.md` stub replaced by `guides/versioning-and-releases.md`; `usage.md` split into `guides/calling-the-workflow.md` + `reference/workflow-inputs.md`; `configuration.md` split into `guides/configuring-the-pipeline.md` + `reference/settings.md`; test-authoring content extracted from `pipeline-stages.md` into `guides/writing-module-tests.md`. - New reference pages: `scenario-matrix.md`, `framework-test-ids.md`, `dependencies.md`, plus a `specification/index.md` section landing page. - `design.md` documented `.github/PSModule.yml` with `Enabled:` keys while the real authorable contract uses `Skip:`. Rather than restate the contract, it now links to `reference/settings.md`, which removes the contradiction. - `design.md` also carried its own copy of the runtime `Settings` table that had drifted from the one in `pipeline-stages.md` (`Test.Module.Enabled` vs the actual `BeforeAllEnabled`/`MainEnabled`/`AfterAllEnabled`). It now links to the pipeline-stages copy. - Linter configuration consolidated: the duplicated `docs/.github/linters/*` set is removed in favour of the repository-level `.github/linters/*`, with the codespell, markdownlint, and PSScriptAnalyzer profiles updated to cover the docs corpus. - `docs/zensical.toml` nav rewritten to the four-section hierarchy. `navigation.indexes` is already enabled, so each section index is clickable and there are no dead nav nodes. - Validation performed: every relative markdown link across `docs/content` resolves; every in-tree heading anchor referenced by a link exists; every `zensical.toml` nav entry points at an existing file. This also clears two pre-existing broken links to `../PowerShell/Standard/index.md` in `Module-Types.md` and `Standards.md`. - No callable workflow contract changed. `.github/workflows/workflow.yml` and the reusable sub-workflows are untouched; only the repository-internal `Docs.yml` and linter configs are modified, so there is no release impact for consumers. - Delivery leaf: this pull request has no scoped closing Task or Bug. It needs one under #423 before it satisfies the Definition of Ready for Review. </details> <details> <summary>Relevant issues (or links)</summary> - #423 </details> --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent d1e2feb commit aa89bbe

46 files changed

Lines changed: 1228 additions & 1655 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/linters/.codespellrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[codespell]
22
skip = ./.github/linters
3-
ignore-words-list = afterall
3+
ignore-words-list = afterall,skelton,erformance

.github/linters/.markdown-lint.yml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,21 @@
88
###############
99
# Rules by id #
1010
###############
11-
MD004: false # Unordered list style
11+
MD004: false # Unordered list style
1212
MD007:
13-
indent: 2 # Unordered list indentation
13+
indent: 2 # Unordered list indentation
1414
MD013:
15-
line_length: 808 # Line length
15+
line_length: 3000 # Line length
16+
MD025: false # Allow front-matter title + visible H1 on docs pages
1617
MD026:
17-
punctuation: ".,;:!。,;:" # List of not allowed
18-
MD029: false # Ordered list item prefix
19-
MD033: false # Allow inline HTML
20-
MD036: false # Emphasis used instead of a heading
21-
MD060:
22-
style: "leading" # Table column style (leading avoids emoji width issues)
18+
punctuation: '.,;:!。,;:' # List of not allowed
19+
MD029: false # Ordered list item prefix
20+
MD033: false # Allow inline HTML
21+
MD036: false # Emphasis used instead of a heading
22+
MD041: false # First line in file should be a top level heading, PULL_REQUEST_TEMPLATE.md is an exception
23+
MD060: false # Documentation uses both compact and aligned table styles
2324

2425
#################
2526
# Rules by tags #
2627
#################
27-
blank_lines: false # Error on blank lines
28+
blank_lines: false # Error on blank lines

.github/linters/.powershell-psscriptanalyzer.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
}
5151
}
5252
ExcludeRules = @(
53-
'PSAvoidUsingWriteHost', # Write-Host is acceptable in GitHub Actions runners
53+
'PSAvoidUsingWriteHost', # Write-Host is acceptable in GitHub Actions runners and docs tooling scripts
5454
'PSMissingModuleManifestField', # This rule is not applicable until the module is built.
5555
'PSUseToExportFieldsInManifest'
5656
)

.github/workflows/Docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ jobs:
5050
ENABLE_GITHUB_ACTIONS_STEP_SUMMARY: true
5151
ENABLE_GITHUB_PULL_REQUEST_SUMMARY_COMMENT: true
5252
FILTER_REGEX_INCLUDE: '.*(docs/.*|\.github/actions/update-index/.*|\.github/workflows/Docs\.yml)$'
53-
LINTER_RULES_PATH: docs/.github/linters
53+
LINTER_RULES_PATH: .github/linters
5454
SAVE_SUPER_LINTER_SUMMARY: true
5555
VALIDATE_BIOME_LINT: false
5656
VALIDATE_BIOME_FORMAT: false

docs/.github/linters/.codespellrc

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/.github/linters/.markdown-lint.yml

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/.github/linters/.powershell-psscriptanalyzer.psd1

Lines changed: 0 additions & 57 deletions
This file was deleted.

0 commit comments

Comments
 (0)