Skip to content

Commit 25681a1

Browse files
committed
chore: declare developer docs bootstrap contract
1 parent 3182a61 commit 25681a1

1 file changed

Lines changed: 38 additions & 1 deletion

File tree

.github/workflows/developer-docs-agent.yml

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,50 @@ concurrency:
1818
jobs:
1919
developer-docs-agent:
2020
name: Maintain Developer Docs
21-
uses: Automattic/docs-agent/.github/workflows/maintain-docs.yml@main
21+
uses: Automattic/docs-agent/.github/workflows/maintain-docs.yml@71308ff49538b2a27f1cebe50ee9477e6268a1ce
2222
with:
2323
audience: technical
2424
run_kind: ${{ github.event_name == 'workflow_dispatch' && 'bootstrap' || 'maintenance' }}
2525
base_ref: trunk
2626
docs_branch: docs-agent/build-with-wordpress-developer-docs
2727
writable_paths: README.md,docs/**,plugins/**/README.md
28+
bootstrap_contract: |
29+
{
30+
"required_paths": [
31+
"README.md",
32+
"docs/README.md",
33+
"docs/architecture.md",
34+
"docs/generated-outputs.md",
35+
"docs/skills-and-integrations.md",
36+
"docs/contributor-workflows.md"
37+
],
38+
"required_globs": [
39+
{
40+
"pattern": "docs/**/*.md",
41+
"min": 5
42+
}
43+
],
44+
"entry_points": [
45+
{
46+
"path": "README.md",
47+
"must_link_to": ["docs/README.md"]
48+
},
49+
{
50+
"path": "docs/README.md",
51+
"must_link_to": [
52+
"docs/architecture.md",
53+
"docs/generated-outputs.md",
54+
"docs/skills-and-integrations.md",
55+
"docs/contributor-workflows.md"
56+
]
57+
}
58+
],
59+
"forbidden_phrases": [
60+
"future coverage",
61+
"deferred",
62+
"saved for later"
63+
]
64+
}
2865
context_repositories: |
2966
[
3067
{

0 commit comments

Comments
 (0)