Skip to content

Commit 779132c

Browse files
Move Process-PSModule documentation to the site root
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent b23666b commit 779132c

32 files changed

Lines changed: 134 additions & 174 deletions

AGENTS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ If you find a problem or improvement, fix if small; otherwise open an issue.
1515
Regarding repo structure, module source code, and how the Process-PSModule workflow
1616
works. For PSModule-specific build, layout, and process guidance:
1717

18-
- [Process-PSModule docs](https://psmodule.github.io/docs/Modules/Process-PSModule/)
18+
- [Process-PSModule docs](https://psmodule.io/docs/)
1919
repository structure, module anatomy, and the build/test/pack/publish pipeline.
2020
- [Repository defaults](https://psmodule.github.io/docs/Modules/Repository-Defaults/)
2121
the expected repository layout and required files.
@@ -28,11 +28,11 @@ works. For PSModule-specific build, layout, and process guidance:
2828

2929
For cross-cutting ways of working and standards:
3030

31-
- [Agentic Development](https://msxorg.github.io/docs/Ways-of-Working/Agentic-Development/)
31+
- [Agentic Development](https://msx.no/docs/Ways-of-Working/Agentic-Development/)
3232
how agents and humans collaborate in this ecosystem.
33-
- [Ways of Working](https://msxorg.github.io/docs/Ways-of-Working/) — contribution
33+
- [Ways of Working](https://msx.no/docs/Ways-of-Working/) — contribution
3434
workflow, branching, PRs, issues.
35-
- [Coding Standards](https://msxorg.github.io/docs/Coding-Standards/) — language-level
35+
- [Coding Standards](https://msx.no/docs/Coding-Standards/) — language-level
3636
conventions.
3737
- [MSXOrg/memory](https://github.com/MSXOrg/memory) — durable agent working memory:
3838
gotchas, knowledge, and agent role notes.

docs/content/Modules/Catalog/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This catalog tracks modules maintained in the PSModule organization and what each module does.
44

5-
The catalog is separate from the [Process-PSModule framework](../Process-PSModule/index.md). Use the framework documentation to build and release a module; use this page to discover the modules available to install and use.
5+
The catalog is separate from the [Process-PSModule framework](../../index.md). Use the framework documentation to build and release a module; use this page to discover the modules available to install and use.
66

77
## Scope
88

docs/content/Modules/Module-Types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Module types
22

33
Most PSModule modules fall into one of a few archetypes. The general rules in
4-
[PowerShell module standard](Standards.md) and [MSX PowerShell Standards](https://msxorg.github.io/docs/Coding-Standards/PowerShell/) always apply; this
4+
[PowerShell module standard](Standards.md) and [MSX PowerShell Standards](https://msx.no/docs/Coding-Standards/PowerShell/) always apply; this
55
page adds the conventions that are specific to a module's type so that modules of the same kind feel
66
the same to use.
77

docs/content/Modules/Process-PSModule/index.md

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

docs/content/Modules/Repository-Standard.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This is the PSModule organization's Repository Standard. It applies to the PSModule organization and is the standard for PowerShell module repositories. It describes what a newly created or maintained module repository should look like before module-specific code, tests, documentation, and managed repository files are considered.
44

5-
This standard operates at the same altitude as the [MSX Enterprise Repository Standard](https://msxorg.github.io/docs/Ways-of-Working/Repository-Standard/): MSX sets the enterprise-wide default, and this standard adds to and adjusts that default for PowerShell module repositories. Rules this standard does not change are inherited from the MSX default; where this standard adds or overrides a rule, it governs PowerShell module repositories.
5+
This standard operates at the same altitude as the [MSX Enterprise Repository Standard](https://msx.no/docs/Ways-of-Working/Repository-Standard/): MSX sets the enterprise-wide default, and this standard adds to and adjusts that default for PowerShell module repositories. Rules this standard does not change are inherited from the MSX default; where this standard adds or overrides a rule, it governs PowerShell module repositories.
66

77
The implementation standard still lives in [PowerShell module standard](Standards.md). Type-specific conventions for integration (API) and data modules live in [Module types](Module-Types.md). This page covers the repository standard for module repositories: files, metadata, README shape, release integration, placeholder handling, shared community files, and managed-file distribution.
88

@@ -70,7 +70,7 @@ Local work should use the organization worktree convention:
7070
- `main/` tracks the default branch.
7171
- Feature worktrees use `<type>-<slug>` directories and `<type>/<slug>` branches.
7272

73-
For branch and worktree details, see [Git Worktrees](https://msxorg.github.io/docs/Ways-of-Working/Git-Worktrees/).
73+
For branch and worktree details, see [Git Worktrees](https://msx.no/docs/Ways-of-Working/Git-Worktrees/).
7474

7575
## Default repository layout
7676

@@ -173,7 +173,7 @@ See [PSModule/Template-PSModule](https://github.com/PSModule/Template-PSModule)
173173

174174
`AGENTS.md` and `CLAUDE.md` are the required set. `AGENTS.md` is the entry point that AGENTS.md-aware runtimes read directly, so a repository is usable by an agent without a per-runtime copy of the same pointer.
175175

176-
Runtime-specific adapter files such as `.github/copilot-instructions.md` and `.github/instructions/*.instructions.md` are optional. MSX treats them as client adapters that *may* add runtime-specific loading or path rules, described in [Agentic Development](https://msxorg.github.io/docs/Ways-of-Working/Agentic-Development/) and its [capability specification](https://msxorg.github.io/docs/Capabilities/agentic-development/spec/). Add one when a runtime needs loading or path rules that `AGENTS.md` cannot express, and keep it pointing at `AGENTS.md` rather than restating it. `Template-PSModule` ships without one.
176+
Runtime-specific adapter files such as `.github/copilot-instructions.md` and `.github/instructions/*.instructions.md` are optional. MSX treats them as client adapters that *may* add runtime-specific loading or path rules, described in [Agentic Development](https://msx.no/docs/Ways-of-Working/Agentic-Development/) and its [capability specification](https://msx.no/docs/Capabilities/agentic-development/spec/). Add one when a runtime needs loading or path rules that `AGENTS.md` cannot express, and keep it pointing at `AGENTS.md` rather than restating it. `Template-PSModule` ships without one.
177177

178178
These files are the agent equivalent of the README: pointers, not copies. Keep them short so the linked documentation stays the single source of truth. Like the other governance files, they live in the repository itself so it can stand on its own.
179179

docs/content/Modules/Standards.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Standards for implementing and reviewing PowerShell modules in the PSModule organization. These rules apply to modules built with the [PSModule framework](https://github.com/PSModule/Process-PSModule).
44

5-
For general PowerShell coding standards (naming, style, function structure, documentation, readability, error handling), see [MSX PowerShell Standards](https://msxorg.github.io/docs/Coding-Standards/PowerShell/). This page covers only module-specific conventions.
5+
For general PowerShell coding standards (naming, style, function structure, documentation, readability, error handling), see [MSX PowerShell Standards](https://msx.no/docs/Coding-Standards/PowerShell/). This page covers only module-specific conventions.
66

77
## Supported PowerShell version
88

docs/content/Modules/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Process-PSModule is the framework for building, testing, versioning, documenting, and publishing PowerShell modules. These foundations define the repository, source, test, and release conventions that the framework supports and validates.
44

5-
Start with the [Process-PSModule overview](Process-PSModule/index.md) to understand the workflow. Use these pages when creating or maintaining a module that runs through it.
5+
Start with the [Process-PSModule overview](../index.md) to understand the workflow. Use these pages when creating or maintaining a module that runs through it.
66

77
| Page | Use it for |
88
| --- | --- |

docs/content/Modules/Process-PSModule/get-started/index.md renamed to docs/content/get-started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ If the module needs several interdependent commands before it is usable at all,
3434
| [Your first release](your-first-release.md) | The pull request flow, version labels, and what happens on merge. |
3535
| [Module bootstrap](module-bootstrap.md) | Getting a brand-new module to its first release with an integration branch. |
3636

37-
For framework-level practices, refer to [MSX Ways of Working](https://msxorg.github.io/docs/Ways-of-Working/).
37+
For framework-level practices, refer to [MSX Ways of Working](https://msx.no/docs/Ways-of-Working/).

docs/content/Modules/Process-PSModule/get-started/module-bootstrap.md renamed to docs/content/get-started/module-bootstrap.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A brand-new module usually has a small **load-bearing core**: the piece(s) every
99

1010
## Identify the load-bearing core first
1111

12-
What counts as "load-bearing" follows the module's archetype from [Module types](../../Module-Types.md):
12+
What counts as "load-bearing" follows the module's archetype from [Module types](../Modules/Module-Types.md):
1313

1414
- **Data modules** — the conversion pivot: `ConvertFrom-<Format>` / `ConvertTo-<Format>` (and whatever parser/serializer they wrap). Every other function (`Import-`, `Export-`, `Format-`, `Merge-`, ...) is built on top of this pivot and is meaningless without it.
1515
- **Integration (API) modules** — a [`Context`](https://github.com/PSModule/Context)-backed credential/config store, the client setup that uses it, and at least one API function that consumes the context end-to-end. Every other API function needs the same context and client to do anything.
@@ -19,13 +19,13 @@ Scope the integration branch to exactly that core, not to everything planned for
1919
## Pattern
2020

2121
1. Cut one long-lived branch from the default branch for the initial release, named for the outcome, e.g. `build-thing-module`.
22-
2. Open one pull request per function (or small group of related functions) targeting that branch instead of `main`. These PRs can land in parallel — there is no strict order between them, unlike a [stacked pull request](https://msxorg.github.io/docs/Ways-of-Working/Branching-and-Merging/#stacked-pull-requests).
22+
2. Open one pull request per function (or small group of related functions) targeting that branch instead of `main`. These PRs can land in parallel — there is no strict order between them, unlike a [stacked pull request](https://msx.no/docs/Ways-of-Working/Branching-and-Merging/#stacked-pull-requests).
2323
3. Once the load-bearing core is coherent and complete, open the pull request that merges the integration branch into `main`. This becomes the module's first real release (`v1.0.0`).
2424
4. Smaller follow-up features (one more function, a formatter, an alias) can keep targeting the integration branch before it lands, the same way they targeted it during bootstrap.
2525

2626
## After the core lands
2727

28-
Once the core has merged as `v1.0.0`, ordinary [SemVer](../../Versioning.md) applies: a new function built on the stable core is a **minor** bump, a fix is a **patch** bump, and only a change to the core's own contract (signature, exported class shape, behavior) is a **major** bump. No special versioning exception is needed once the core is in place — the bootstrap phase exists only to get that core to a first release quickly.
28+
Once the core has merged as `v1.0.0`, ordinary [SemVer](../Modules/Versioning.md) applies: a new function built on the stable core is a **minor** bump, a fix is a **patch** bump, and only a change to the core's own contract (signature, exported class shape, behavior) is a **major** bump. No special versioning exception is needed once the core is in place — the bootstrap phase exists only to get that core to a first release quickly.
2929

3030
```mermaid
3131
gitGraph
@@ -60,6 +60,6 @@ A module bootstrapped this way:
6060
## When to use this
6161

6262
- The module has no usable release yet, and the load-bearing core hasn't landed.
63-
- Use this only for the initial bootstrap. Once `main` has a first release, ongoing feature work targets `main` directly with ordinary topic branches, or a [stacked pull request](https://msxorg.github.io/docs/Ways-of-Working/Branching-and-Merging/#stacked-pull-requests) when changes genuinely depend on each other.
63+
- Use this only for the initial bootstrap. Once `main` has a first release, ongoing feature work targets `main` directly with ordinary topic branches, or a [stacked pull request](https://msx.no/docs/Ways-of-Working/Branching-and-Merging/#stacked-pull-requests) when changes genuinely depend on each other.
6464

65-
For the general branching and merge model, see [MSX Branching and Merging](https://msxorg.github.io/docs/Ways-of-Working/Branching-and-Merging/).
65+
For the general branching and merge model, see [MSX Branching and Merging](https://msx.no/docs/Ways-of-Working/Branching-and-Merging/).

docs/content/Modules/Process-PSModule/get-started/repository-setup.md renamed to docs/content/get-started/repository-setup.md

File renamed without changes.

0 commit comments

Comments
 (0)