Skip to content

Commit e452b74

Browse files
committed
docs: publish domain language guide
1 parent 268fa36 commit e452b74

3 files changed

Lines changed: 35 additions & 29 deletions

File tree

CONTEXT.md

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

CONTEXT.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/reference/domain-language.md

docs/reference/domain-language.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# psake Domain Language
2+
3+
Canonical terminology for psake build definitions and reusable task distribution. This glossary gives contributors, documentation readers, and language models the same vocabulary.
4+
5+
## Language
6+
7+
**Shared task module**:
8+
A PowerShell module that distributes reusable psake task definitions through a module-root `psakeFile.ps1`.
9+
_Avoid_: Shared module, build module, task library
10+
11+
**Provider module**:
12+
The shared task module that owns and distributes reusable task definitions.
13+
_Avoid_: Source module, plugin
14+
15+
**Consumer build**:
16+
A psake build that references tasks from a provider module using `Task -FromModule`.
17+
_Avoid_: Client build, importing build
18+
19+
**Shared task reference**:
20+
A declaration in a consumer build that selects a provider task using `Task -FromModule`; it references a provider definition rather than defining a local task action.
21+
_Avoid_: Imported task, module task import
22+
23+
**Public task**:
24+
A provider task intended for consumers to reference directly. Public status is an authoring convention because psake registers every task in the provider task file without visibility boundaries.
25+
_Avoid_: Exported task
26+
27+
**Supporting task**:
28+
A provider task that exists primarily as a dependency of a public task. It remains directly invocable because psake does not enforce task visibility.
29+
_Avoid_: Private task, internal task

sidebars.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,11 @@ const sidebars: SidebarsConfig = {
121121
items: [
122122
'reference/configuration-reference',
123123
'reference/cheat-sheet',
124+
{
125+
type: 'doc',
126+
label: 'Domain Language',
127+
id: 'reference/domain-language'
128+
},
124129
'reference/glossary',
125130
'reference/exit-codes',
126131
]

0 commit comments

Comments
 (0)