Skip to content

📖 [Docs]: Author Process-PSModule spec and design, move to Capabilities#110

Merged
Marius Storhaug (MariusStorhaug) merged 8 commits into
mainfrom
friendly-adventure
Jul 26, 2026
Merged

📖 [Docs]: Author Process-PSModule spec and design, move to Capabilities#110
Marius Storhaug (MariusStorhaug) merged 8 commits into
mainfrom
friendly-adventure

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

Summary

Process-PSModule gains a technology-agnostic spec and design, then moves from \Frameworks/Process-PSModule\ to \Capabilities/process-psmodule. This unifies the capability/framework documentation model per #102.

Changes

  • Moved folder from \Frameworks/Process-PSModule\ to \Capabilities/process-psmodule\ (lowercase-kebab) with \git mv, preserving history and media assets
  • Authored spec.md: Technology-agnostic requirements (FR1-6: build, cross-platform test, quality/coverage gates, docs generation, label-driven versioned publish; NFR1-5: SemVer, serialized releases, single authority, rapid feedback, reproducibility). Gherkin-format acceptance criteria, no tech/implementation detail.
  • Authored design.md: How it's built—single reusable workflow composing sub-workflows, settings file contract, scenario matrix, alternatives considered
  • Updated index.md: Introduced spec and design; reorganized reference pages under "Reference" section
  • Updated zensical.toml: Moved Process-PSModule nav entry from Frameworks to Capabilities with Spec/Design entries; removed from Frameworks nav
  • Fixed stale links: Updated references in PSModule.md, PowerShell/Testing.md, powershell-on-github/design.md; updated Frameworks/index.md
  • Validated: All checks pass—Update-DocumentationIndex, Test-DocumentationLink, markdownlint

Technical Details

Spec highlights

  • FR1–FR6: Build, cross-platform test (Windows/Linux/macOS), quality/coverage gates, docs generation, label-driven versioning (Major/Minor/Patch/Prerelease/NoRelease), immutable releases
  • NFR1–NFR5: SemVer compliance, serialized releases, single stable authority, rapid feedback, git-auditable
  • Gherkin acceptance criteria for version computation, publication, prerelease workflow, failure handling

Design highlights

  • Single reusable workflow composing Plan, Lint-Repository, Build-Module, Test-SourceCode, Lint-SourceCode, Test-Module, Get-TestResults, Get-CodeCoverage, Publish-Module, Publish-Site
  • Settings file contract with runtime enrichment
  • Scenario matrix: label handling, branch types, platform matrix (Windows/Linux/macOS)
  • Alternatives documented: monolithic vs. composable workflows

Relevant Issues

- Rename folder to lowercase-kebab for consistency with other capabilities
- Preserve git history for all six reference pages and media assets

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
- spec.md: Technology-agnostic requirements (FR1-6, NFR1-5) for the pipeline
- design.md: How it's built—reusable workflow, settings contract, scenario matrix
- index.md: Introduce spec/design; reorganize reference pages under 'Reference' section

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
- Update links in PSModule.md, PowerShell/Testing.md, powershell-on-github/design.md
- Update Frameworks/index.md to remove Process-PSModule reference (now in Capabilities)
- Update zensical.toml nav: move Process-PSModule to Capabilities with Spec/Design

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
- Regenerated index tables for Capabilities/index.md and process-psmodule/index.md
- All links validated
- Markdownlint passed

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@MariusStorhaug Marius Storhaug (MariusStorhaug) added the NoRelease No release required label Jul 26, 2026
- Fixed double-brace {{ #nfr5 }} to single-brace { #nfr5 } for valid attr_list syntax
- Verified with Update-DocumentationIndex, Test-DocumentationLink, markdownlint

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 26, 2026 13:48
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) merged commit c714245 into main Jul 26, 2026
19 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the friendly-adventure branch July 26, 2026 13:51
Marius Storhaug (MariusStorhaug) added a commit that referenced this pull request Jul 26, 2026
#110)

- Folder moved: src/docs/Frameworks/Agentic-Development → src/docs/Capabilities/agentic-development
- Nav updated in zensical.toml: added under Capabilities alongside Process-PSModule, removed from Frameworks
- Frameworks nav now empty (both frameworks moved to Capabilities); Frameworks/index.md updated with retirement note
- Links fixed: Repository-Type-Property.md (2 occurrences) updated to new path
- Indexes regenerated: Capabilities/index.md and Frameworks/index.md auto-updated
- All validation passing: links resolve, markdownlint clean (112 files, 0 issues)

Rebased on main (commit c714245 after PR #110: Process-PSModule moved to Capabilities).

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Marius Storhaug (MariusStorhaug) added a commit that referenced this pull request Jul 26, 2026
…109)

Agentic-Development framework moves from the standalone Frameworks
section into Capabilities, unifying the capability and framework
concepts under a single spec-and-design model. The framework now lives
alongside every other capability — Release Management, Dependency
Updates, Merge Automation, Downstream Release Propagation, VS Code
Extension Framework, PowerShell on GitHub, and Process-PSModule — all
documented consistently by spec (why and what) and design (how).

## Changed: Agentic-Development location and navigation

Agentic-Development now appears under Capabilities in the documentation
site navigation. All four pages (spec.md, design.md, index.md,
memory-template.md) retain their content, front matter, and internal
structure — only their storage location and navigation path changed. The
memory-template.md is still the canonical reference for teams setting up
an Agentic Development org-wide memory repository.

Links throughout the ecosystem that pointed to the old
`Frameworks/Agentic-Development/...` path now point to
`Capabilities/agentic-development/...`. The relative link depth is
unchanged — both old and new locations are two levels under `src/docs`,
so cross-document references like `../../Ways-of-Working/...` continue
to work without modification.

---
<details>
<summary>Technical details</summary>

- Folder moved via `git mv` to preserve commit history:
`src/docs/Frameworks/Agentic-Development/` →
`src/docs/Capabilities/agentic-development/`
- Folder name follows lowercase-kebab convention (matches
`release-management`, `dependency-updates`, `process-psmodule`, etc.)
- `src/zensical.toml`: Added Agentic Development group under
Capabilities nav (index.md, Spec, Design, Memory Repository Template);
removed from Frameworks nav
- Inbound links fixed:
`src/docs/Ways-of-Working/Repository-Type-Property.md` (2 occurrences)
updated to reference new path
- `src/docs/Frameworks/index.md`: Removed Agentic-Development entry;
Frameworks section now states retirement pending
- Auto-generated indexes regenerated: `Capabilities/index.md` and
`Frameworks/index.md` updated by `Update-DocumentationIndex.ps1`
- All validation passing: `Test-DocumentationLink.ps1` confirms all
links resolve; markdownlint reports 0 issues
- Rebased on main (commit c714245) after PR #110 merged Process-PSModule
to Capabilities; merge-tree confirms zero conflicts

</details>

<details>
<summary>Relevant issues</summary>

- Resolves #107
- #102

</details>

---------

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Marius Storhaug (MariusStorhaug) pushed a commit that referenced this pull request Jul 26, 2026
Integrate #109 (Agentic-Development move) and #110 (Process-PSModule) plus the
Frameworks section removal now on main. Resolve the modify/delete on
Frameworks/index.md by accepting the deletion, drop the now-dangling Frameworks
link from Capabilities/index.md, and regenerate the index tables.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

NoRelease No release required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant