Skip to content

Commit 91db22c

Browse files
tablackburnclaude
andcommitted
chore: add .gitattributes, markdownlint config, and about_ help stub
- .gitattributes: mark docs/en-US/* as linguist-generated so platyPS-generated help files don't skew GitHub language stats. - .markdownlint-cli2.jsonc: relax MD013 in tables and code blocks, allow MD024 duplicate headings under different parents, and ignore AGENTS.md, the generated docs/en-US/**, and the instructions/** AI-agent guides. - docs/en-US/about_{{ModuleName}}.help.md: stub for Get-Help about_<Module>. Initialize-Template.ps1 already renames {{ModuleName}} files in docs/en-US. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 9b49425 commit 91db22c

3 files changed

Lines changed: 41 additions & 0 deletions

File tree

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# The docs are generated by the build script and should be considered artifacts
2+
docs/en-US/* linguist-generated

.markdownlint-cli2.jsonc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.19.1/schema/markdownlint-cli2-config-schema.json",
3+
"config": {
4+
"MD013": {
5+
"tables": false,
6+
"code_blocks": false
7+
},
8+
"MD024": {
9+
"siblings_only": true
10+
}
11+
},
12+
"ignores": [
13+
"AGENTS.md",
14+
// Intentionally narrow: only ignores docs/en-US (platyPS-generated help) so that
15+
// other markdown files in docs/ are still linted. No other language directories
16+
// are expected.
17+
"docs/en-US/**",
18+
"instructions/**"
19+
]
20+
}

docs/en-US/about_{{ModuleName}}.help.md

Lines changed: 19 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)