@haus-tech/haus-workflow 6.7.1 → 6.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/cli.js +4617 -1761
  3. package/package.json +3 -1
  4. package/packages/agents/issue-creator.md +61 -0
  5. package/packages/configs/eslint/eslint.config.mjs +90 -0
  6. package/packages/configs/lighthouse/lighthouserc.yml +35 -0
  7. package/packages/configs/prettier/.prettierignore +28 -0
  8. package/packages/configs/prettier/prettier.config.cjs +12 -0
  9. package/packages/packages.yaml +81 -0
  10. package/packages/skills/adr-decisions/SKILL.md +114 -0
  11. package/packages/skills/auth-oidc-azure-bankid-patterns/SKILL.md +46 -0
  12. package/packages/skills/auth-oidc-azure-bankid-patterns/references/conventions.md +29 -0
  13. package/packages/skills/auth-oidc-azure-bankid-patterns/references/scope.md +30 -0
  14. package/packages/skills/auth-oidc-azure-bankid-patterns/references/workflow.md +38 -0
  15. package/packages/skills/bullmq-patterns/SKILL.md +63 -0
  16. package/packages/skills/bullmq-patterns/references/conventions.md +33 -0
  17. package/packages/skills/bullmq-patterns/references/scope.md +30 -0
  18. package/packages/skills/bullmq-patterns/references/workflow.md +50 -0
  19. package/packages/skills/i18next-patterns/SKILL.md +62 -0
  20. package/packages/skills/i18next-patterns/references/conventions.md +32 -0
  21. package/packages/skills/i18next-patterns/references/scope.md +29 -0
  22. package/packages/skills/i18next-patterns/references/workflow.md +39 -0
  23. package/packages/skills/issue-authoring/SKILL.md +191 -0
  24. package/packages/skills/issue-authoring/references/issue-tracker.md +29 -0
  25. package/packages/skills/issue-authoring/references/native-metadata.md +122 -0
  26. package/packages/skills/issue-authoring/references/recording-approval.md +29 -0
  27. package/packages/skills/laravel-nova-patterns/SKILL.md +55 -0
  28. package/packages/skills/laravel-nova-patterns/references/conventions.md +26 -0
  29. package/packages/skills/laravel-nova-patterns/references/scope.md +30 -0
  30. package/packages/skills/laravel-nova-patterns/references/workflow.md +36 -0
  31. package/packages/skills/nextauth-patterns/SKILL.md +48 -0
  32. package/packages/skills/nextauth-patterns/references/conventions.md +33 -0
  33. package/packages/skills/nextauth-patterns/references/scope.md +33 -0
  34. package/packages/skills/nextauth-patterns/references/workflow.md +46 -0
  35. package/packages/skills/nx-tag-conventions/SKILL.md +32 -0
  36. package/packages/skills/package-manager-yarn4-pnpm89/SKILL.md +41 -0
  37. package/packages/skills/package-manager-yarn4-pnpm89/references/conventions.md +25 -0
  38. package/packages/skills/package-manager-yarn4-pnpm89/references/scope.md +30 -0
  39. package/packages/skills/package-manager-yarn4-pnpm89/references/workflow.md +39 -0
  40. package/packages/skills/qliro-patterns/SKILL.md +48 -0
  41. package/packages/skills/qliro-patterns/references/conventions.md +28 -0
  42. package/packages/skills/qliro-patterns/references/scope.md +30 -0
  43. package/packages/skills/qliro-patterns/references/workflow.md +46 -0
  44. package/packages/skills/react-router-v7-patterns/SKILL.md +47 -0
  45. package/packages/skills/react-router-v7-patterns/references/conventions.md +30 -0
  46. package/packages/skills/react-router-v7-patterns/references/scope.md +32 -0
  47. package/packages/skills/react-router-v7-patterns/references/workflow.md +43 -0
  48. package/{library/global → packages}/skills/request/scripts/korning.mjs +1 -1
  49. package/packages/skills/strapi-patterns/SKILL.md +63 -0
  50. package/packages/skills/strapi-patterns/references/conventions.md +33 -0
  51. package/packages/skills/strapi-patterns/references/scope.md +29 -0
  52. package/packages/skills/strapi-patterns/references/workflow.md +47 -0
  53. package/packages/skills/vendure-app-patterns/SKILL.md +44 -0
  54. package/packages/skills/vendure-app-patterns/references/conventions.md +25 -0
  55. package/packages/skills/vendure-app-patterns/references/scope.md +29 -0
  56. package/packages/skills/vendure-app-patterns/references/workflow.md +45 -0
  57. package/packages/skills/vendure-plugin-patterns/SKILL.md +55 -0
  58. package/packages/skills/vendure-plugin-patterns/references/conventions.md +27 -0
  59. package/packages/skills/vendure-plugin-patterns/references/scope.md +30 -0
  60. package/packages/skills/vendure-plugin-patterns/references/workflow.md +42 -0
  61. package/packages/skills/whats-installed/SKILL.md +53 -0
  62. package/packages/skills/wordpress-acf-elementor-jetengine-patterns/SKILL.md +41 -0
  63. package/packages/skills/wordpress-acf-elementor-jetengine-patterns/references/conventions.md +25 -0
  64. package/packages/skills/wordpress-acf-elementor-jetengine-patterns/references/scope.md +28 -0
  65. package/packages/skills/wordpress-acf-elementor-jetengine-patterns/references/workflow.md +41 -0
  66. package/packages/skills/wordpress-bedrock-patterns/SKILL.md +41 -0
  67. package/packages/skills/wordpress-bedrock-patterns/references/conventions.md +27 -0
  68. package/packages/skills/wordpress-bedrock-patterns/references/scope.md +28 -0
  69. package/packages/skills/wordpress-bedrock-patterns/references/workflow.md +42 -0
  70. package/packages/skills/writing-documentation/SKILL.md +161 -0
  71. package/packages/skills/writing-documentation/references/claude-template-workspace.md +60 -0
  72. package/packages/skills/writing-documentation/references/claude-template.md +43 -0
  73. package/packages/skills/writing-documentation/references/completeness-criteria.md +26 -0
  74. package/packages/skills/writing-documentation/references/summary-template.md +81 -0
  75. package/packages/skills/writing-documentation/references/topic-file-formats.md +125 -0
  76. package/packages/skills/writing-documentation/references/validation-checklist.md +42 -0
  77. package/packages/templates/agentic-workflow-poc.md +180 -0
  78. package/packages/templates/agentic-workflow-standard.md +160 -0
  79. package/packages/templates/decision-template.md +27 -0
  80. package/packages/templates/decisions-ci-gate.yml +32 -0
  81. package/packages/templates/lefthook-branch-guard.yml +27 -0
  82. package/packages/templates/lefthook-lighthouse.yml +28 -0
  83. package/packages/templates/lefthook-quality.yml +34 -0
  84. package/packages/templates/lefthook-security.yml +27 -0
  85. package/packages/templates/start-here.md +72 -0
  86. /package/{library/global → packages}/agents/request-assessor.md +0 -0
  87. /package/{library/global → packages}/agents/request-design-reviewer.md +0 -0
  88. /package/{library/global → packages}/agents/request-designer.md +0 -0
  89. /package/{library/global → packages}/agents/request-scorer.md +0 -0
  90. /package/{library/global → packages}/agents/request-specifier-eskalerad.md +0 -0
  91. /package/{library/global → packages}/agents/request-specifier.md +0 -0
  92. /package/{library/global → packages}/skills/haus-workflow/SKILL.md +0 -0
  93. /package/{library/global → packages}/skills/haus-workflow/references/clone.md +0 -0
  94. /package/{library/global → packages}/skills/haus-workflow/references/init.md +0 -0
  95. /package/{library/global → packages}/skills/haus-workflow/references/new.md +0 -0
  96. /package/{library/global → packages}/skills/request/SKILL.md +0 -0
  97. /package/{library/global → packages}/skills/request/scripts/archive.mjs +0 -0
  98. /package/{library/global → packages}/skills/request/scripts/bedom.mjs +0 -0
  99. /package/{library/global → packages}/skills/request/scripts/check-lasta.mjs +0 -0
  100. /package/{library/global → packages}/skills/request/scripts/compare-scores.mjs +0 -0
  101. /package/{library/global → packages}/skills/request/scripts/contract-check.mjs +0 -0
  102. /package/{library/global → packages}/skills/request/scripts/kontroll.mjs +0 -0
  103. /package/{library/global → packages}/skills/request/scripts/lib.mjs +0 -0
  104. /package/{library/global → packages}/skills/request/scripts/precheck.mjs +0 -0
  105. /package/{library/global → packages}/skills/request/scripts/ref-hash.mjs +0 -0
  106. /package/{library/global → packages}/skills/request/scripts/report.mjs +0 -0
  107. /package/{library/global → packages}/skills/request/scripts/resolve-anchors.mjs +0 -0
  108. /package/{library/global → packages}/skills/request/scripts/svep.mjs +0 -0
  109. /package/{library/global → packages}/skills/request-assess-impact/SKILL.md +0 -0
  110. /package/{library/global → packages}/skills/request-score/SKILL.md +0 -0
  111. /package/{library/global → packages}/skills/request-score/references/poangskala.md +0 -0
  112. /package/{library/global → packages}/skills/request-sync/SKILL.md +0 -0
  113. /package/{library/global → packages}/skills/request-write-spec/SKILL.md +0 -0
  114. /package/{library/global → packages}/skills/request-write-spec/references/specformat.md +0 -0
  115. /package/{library/global → packages}/skills/slack-cowork/SKILL.md +0 -0
  116. /package/{library/global → packages}/skills/slack-cowork/references/canvas-markdown.md +0 -0
  117. /package/{library/global → packages}/skills/slack-cowork/references/synk.md +0 -0
@@ -0,0 +1,42 @@
1
+ # Workflow
2
+
3
+ ## Implementation steps
4
+
5
+ 1. Start from `*.plugin.ts`: identify `SchemaExtensionScope`, entity list, and provider registrations
6
+ 2. For new entity: create TypeORM entity extending `VendureEntity`; generate migration; register in plugin `entities`
7
+ 3. For new API field: add to `gqlShopExtension` or `gqlAdminExtension` SDL; implement resolver method
8
+ 4. Apply `@Allow(Permission.*)` to admin mutations — check permission enum in Vendure core
9
+ 5. For shop API mutations: verify customer authentication check where required
10
+ 6. Implement service method called from resolver; inject `TransactionalConnection` for DB access
11
+ 7. Run codegen to regenerate plugin types after SDL change
12
+ 8. Write e2e spec: bootstrap Vendure test server, call mutation/query, assert DB state
13
+
14
+ ## Commands
15
+
16
+ ```bash
17
+ # Generate TypeORM migration for plugin entity
18
+ yarn typeorm migration:generate -- -n PluginEntityMigration -d src/vendure-config.ts
19
+
20
+ # GraphQL codegen (plugin-level)
21
+ yarn graphql-codegen --config codegen.ts
22
+
23
+ # Type check
24
+ yarn tsc --noEmit
25
+
26
+ # Run plugin e2e tests
27
+ jest --testPathPattern e2e-spec
28
+ jest --testPathPattern plugin-name
29
+
30
+ # Build plugin package
31
+ yarn build / yarn tsup src/index.ts
32
+ ```
33
+
34
+ ## Validation checklist
35
+
36
+ - [ ] Plugin entity registered in `@VendurePlugin({ entities: [...] })` array
37
+ - [ ] Migration generated and reviewed before testing schema-dependent behavior
38
+ - [ ] Admin mutations decorated with `@Allow(Permission.*)` — no unprotected admin writes
39
+ - [ ] Shop mutations check customer authentication where user-specific data accessed
40
+ - [ ] Resolver delegates to service — no direct DB queries in resolver methods
41
+ - [ ] Plugin does not import from Vendure internal paths (only `@vendure/core`)
42
+ - [ ] e2e spec covers success path, unauthorized access, and invalid input rejection
@@ -0,0 +1,53 @@
1
+ ---
2
+ name: whats-installed
3
+ description: Use when someone asks what is installed in this project, what they can ask for, what haus set up, where to start, or for a menu of available skills and helpers — especially when the person asking is not a developer. Triggers include "what's installed", "what can I ask for", "what can you help with here", "start here", "vad är installerat", "vad kan jag be om hjälp med".
4
+ ---
5
+
6
+ # What's Installed
7
+
8
+ Turn the machine inventory of haus-installed content into a plain-language
9
+ menu the person in front of you can act on. The reader may be a project
10
+ manager, a designer, or a content person — never assume they know git, the
11
+ file tree, or what a "skill" is.
12
+
13
+ ## Where the inventory lives
14
+
15
+ Read, in this order:
16
+
17
+ 1. `.haus-workflow/haus.lock.json` — the authoritative list of installed
18
+ catalog items: id, type, version, and installed paths. Prefer this.
19
+ 2. If the lock file is missing, list what is on disk instead:
20
+ `.claude/skills/`, `.claude/agents/`, `.claude/commands/`,
21
+ `.claude/rules/`, `.claude/templates/`.
22
+ 3. `.claude/templates/start-here.md` — a plain-language onboarding page. If
23
+ it exists and the reader is non-technical, mention it as the standing
24
+ reference they can come back to without you.
25
+
26
+ ## How to answer
27
+
28
+ - **Answer in the language the person asked in.**
29
+ - **Group by what the reader can do, not by item type.** "Working with code",
30
+ "Reviewing and quality", "Writing and planning", "Project rules" — not
31
+ "skills, agents, rules, templates".
32
+ - **Translate ids into outcomes.** `haus.react-router-v7-patterns`
33
+ becomes "guidance for the routing library this app uses" — say what
34
+ it helps with, never recite the id at a non-technical reader.
35
+ - **One line per item, phrased as something to say.** "Ask me to review a
36
+ change before it ships" beats "code-review skill available".
37
+ - **Match depth to the reader.** A developer can get ids, versions, and
38
+ paths on request; a non-technical reader gets the menu and example
39
+ requests only.
40
+ - **Never dump raw JSON**, the lock file, or directory listings into the
41
+ conversation — that is the inventory, not the answer.
42
+ - **End with two or three example requests** tailored to this specific
43
+ project, so the reader can copy one and go.
44
+
45
+ ## Do not
46
+
47
+ - Do not install, remove, or update anything — this skill is read-only.
48
+ Changing what is installed is the haus CLI's job (`haus apply`,
49
+ `haus update`), run by a developer.
50
+ - Do not list items that are not actually present in this project.
51
+ - Do not recite `.haus-workflow/WORKFLOW.md` at a non-technical reader.
52
+ If they ask about the team's working rules, summarize only the part they
53
+ asked about, in plain language.
@@ -0,0 +1,41 @@
1
+ ---
2
+ name: wordpress-acf-elementor-jetengine-patterns
3
+ description: WordPress builder-data router. Use for ACF, Elementor Pro, and JetEngine data/model wiring.
4
+ ---
5
+
6
+ # WordPress ACF Elementor JetEngine Patterns
7
+
8
+ ## Use when
9
+
10
+ - task changes field groups, dynamic templates, listing/grid data, or meta schema
11
+ - task touches ACF JSON/PHP registration, Elementor template hooks, or JetEngine config
12
+
13
+ ## Do not use when
14
+
15
+ - task is generic theme/plugin hook logic without builder/meta impact
16
+ - task is unrelated backend API/service behavior
17
+
18
+ ## Inspect first
19
+
20
+ - ACF field registration (`acf-json/`, PHP field group registration)
21
+ - Elementor template/widget integration files
22
+ - JetEngine custom content type/meta/listing config files
23
+
24
+ ## Avoid mistakes
25
+
26
+ - renaming field keys and breaking existing content mappings
27
+ - coupling presentation templates to unstable raw meta structures
28
+ - missing sanitization/escaping in dynamic output
29
+
30
+ ## Router
31
+
32
+ 1. Load `references/conventions.md` for naming, do/don't, and forbidden patterns.
33
+ 2. Load `references/scope.md` for builder-specific file map.
34
+ 3. Load `references/workflow.md` only when tracing data-to-template flow.
35
+ 4. Preserve backward compatibility for existing field/meta keys.
36
+
37
+ ## References
38
+
39
+ - references/conventions.md
40
+ - references/scope.md
41
+ - references/workflow.md
@@ -0,0 +1,25 @@
1
+ ## Naming conventions
2
+
3
+ - ACF field keys: `snake_case` (e.g. `hero_title`, `cta_button_url`)
4
+ - PHP widget classes: `My_Plugin_Widget_Name` extending `\Elementor\Widget_Base`
5
+ - JetEngine content type slugs: `kebab-case` (e.g. `team-member`, `project-case`)
6
+ - ACF JSON directory: `acf-json/` in theme or plugin root — must be committed to version control
7
+ - JetEngine export JSON: `jet-engine-exports/` directory — committed to version control
8
+
9
+ ## Do / don't
10
+
11
+ DO: Update ALL `get_field('old_key')` / `the_field('old_key')` call sites before or simultaneously with renaming an ACF field key — DON'T: rename ACF field key without searching and updating every callsite
12
+ DO: Commit `acf-json/` directory to version control — DON'T: rely on database-only ACF field group definitions across environments
13
+ DO: Escape all output with appropriate function: `esc_html()`, `esc_url()`, `esc_attr()`, `wp_kses_post()` — DON'T: echo unescaped ACF field values directly
14
+ DO: Register Elementor widgets inside the `elementor/widgets/register` hook — DON'T: register widgets outside this hook (causes load-order errors)
15
+ DO: Check return value of `get_field()` before using it (`if ($value = get_field(...)) { ... }`) — DON'T: assume `get_field()` always returns a usable value
16
+ DO: Export JetEngine content type config to JSON and commit it — DON'T: make JetEngine config changes only in the database
17
+
18
+ ## Forbidden patterns
19
+
20
+ NEVER: ACF field renamed without updating all `get_field()` / `the_field()` callsites — returns empty values silently
21
+ NEVER: Dynamic output without an escaping function — XSS vulnerability
22
+ NEVER: Reference ACF field by label string (use the field key) — labels change; keys are stable identifiers
23
+ NEVER: JetEngine config change not exported to JSON and committed — config lost on DB reset or environment sync
24
+ NEVER: Elementor widget registered outside `elementor/widgets/register` hook — causes class-not-found errors
25
+ NEVER: `acf-json/` directory excluded from version control — field group changes cannot be deployed reliably
@@ -0,0 +1,28 @@
1
+ # Scope
2
+
3
+ ## In-scope files and dirs
4
+
5
+ - `acf-json/` — ACF field group JSON sync files (auto-saved by ACF UI)
6
+ - `inc/acf/**`, `functions.php` sections with `acf_add_local_field_group()` — PHP field registration
7
+ - `inc/elementor/**`, `src/elementor/**` — custom Elementor widget PHP classes
8
+ - `templates/elementor/**` — Elementor template PHP files with dynamic tag integration
9
+ - `inc/jetengine/**` — JetEngine custom content type registration, relations, query config
10
+ - `config/jet-engine/**` — JetEngine exported config JSON (if using import/export)
11
+ - `inc/acf-to-rest/**` — ACF REST API exposure configuration
12
+
13
+ ## Stack boundaries
14
+
15
+ - ACF: field groups, field keys, conditional logic, `get_field()`, `get_sub_field()`, flexible content
16
+ - Elementor Pro: dynamic tags, widget registration, `\Elementor\Widget_Base` extensions
17
+ - JetEngine: custom post types, custom taxonomies, meta fields, listing grids, query builder
18
+ - Not in scope: generic WordPress hook logic without builder/ACF field integration
19
+ - Not in scope: Elementor template design (visual editor only changes)
20
+
21
+ ## Triggers
22
+
23
+ - Adding, renaming, or restructuring an ACF field group or field key
24
+ - Adding a custom Elementor widget class
25
+ - Registering or changing a JetEngine custom content type or meta field
26
+ - Wiring an ACF field to a JetEngine relation
27
+ - Adding a dynamic tag to expose ACF data in Elementor
28
+ - Changing ACF `get_field()` call to updated field key
@@ -0,0 +1,41 @@
1
+ # Workflow
2
+
3
+ ## Implementation steps
4
+
5
+ 1. For ACF field changes: make changes in WP admin ACF UI → ACF auto-saves to `acf-json/` → commit JSON
6
+ 2. For field key renames: update ALL `get_field('old_key')` calls before renaming — or migrate existing content
7
+ 3. For Elementor widget: create PHP class extending `\Elementor\Widget_Base`; register via `elementor/widgets/register` hook
8
+ 4. For JetEngine content type: configure in WP admin; export config JSON; commit to `config/jet-engine/`
9
+ 5. For dynamic tags: register tag class extending `\Elementor\Core\DynamicTags\Tag`; return ACF field value
10
+ 6. Sanitize and escape all dynamic output: `esc_html()`, `esc_url()`, `wp_kses_post()` as appropriate
11
+ 7. Test with real content: populate ACF fields; preview Elementor template with dynamic data enabled
12
+
13
+ ## Commands
14
+
15
+ ```bash
16
+ # WP-CLI commands
17
+ wp acf sync # sync ACF field groups from JSON files
18
+ wp post list --post_type=custom-type # list custom post type entries
19
+
20
+ # Local development
21
+ wp-env start # if using @wordpress/env
22
+ # or: Local by Flywheel / Valet / DDEV
23
+
24
+ # PHP linting
25
+ composer run lint # project-specific lint script
26
+ phpcs --standard=WordPress src/ # WordPress coding standards check
27
+ phpcbf --standard=WordPress src/ # auto-fix
28
+
29
+ # Composer
30
+ composer install # install PHP dependencies
31
+ ```
32
+
33
+ ## Validation checklist
34
+
35
+ - [ ] Renamed ACF field keys: all `get_field('key')` call sites updated
36
+ - [ ] `acf-json/` directory committed with updated field group JSON
37
+ - [ ] Elementor widget registered via `elementor/widgets/register` hook — not deprecated hook
38
+ - [ ] Dynamic output escaped: `esc_html()` for text, `esc_url()` for URLs, `wp_kses_post()` for HTML
39
+ - [ ] JetEngine content type config JSON exported and committed
40
+ - [ ] ACF fields exposed to REST API only if frontend consumption requires it
41
+ - [ ] Template tested with empty/null field values — conditional ACF output handles missing data
@@ -0,0 +1,41 @@
1
+ ---
2
+ name: wordpress-bedrock-patterns
3
+ description: Bedrock router. Use for Roots/Bedrock env/config/bootstrap and WordPress deployment layout concerns.
4
+ ---
5
+
6
+ # WordPress Bedrock Patterns
7
+
8
+ ## Use when
9
+
10
+ - task changes Bedrock config, environment loading, or web/app separation
11
+ - task touches `config/`, `web/`, `composer.json`, or environment mapping files
12
+
13
+ ## Do not use when
14
+
15
+ - task is normal WordPress hook/template logic without Bedrock config impact
16
+ - task is infrastructure outside project repo deployment assumptions
17
+
18
+ ## Inspect first
19
+
20
+ - `config/application.php`, environment-specific config files
21
+ - `composer.json` and Bedrock package wiring
22
+ - `web/app` structure for mu-plugins/themes/plugins placement
23
+
24
+ ## Avoid mistakes
25
+
26
+ - mixing production secrets into committed config
27
+ - changing env precedence and breaking boot order
28
+ - placing code under wrong Bedrock directory root
29
+
30
+ ## Router
31
+
32
+ 1. Load `references/conventions.md` for naming, do/don't, and forbidden patterns.
33
+ 2. Load `references/scope.md` for Bedrock path boundaries.
34
+ 3. Load `references/workflow.md` only for bootstrap/config flow debugging.
35
+ 4. Keep WordPress runtime logic in WP skills, not Bedrock config files.
36
+
37
+ ## References
38
+
39
+ - references/conventions.md
40
+ - references/scope.md
41
+ - references/workflow.md
@@ -0,0 +1,27 @@
1
+ ## Naming conventions
2
+
3
+ - Application config: `config/application.php` — PHP constants and environment bindings
4
+ - Environment overrides: `config/environments/production.php`, `config/environments/development.php`
5
+ - Must-use plugins: `web/app/mu-plugins/` (not `web/wp-content/mu-plugins/`)
6
+ - Regular plugins: `web/app/plugins/` (Composer-installed; never uploaded via WP admin)
7
+ - Themes: `web/app/themes/<theme-name>/`
8
+ - WP core: `web/wp/` — treated as read-only Composer dependency
9
+ - Uploads: `web/app/uploads/` (gitignored)
10
+
11
+ ## Do / don't
12
+
13
+ DO: Install and manage all plugins via `composer.json` only — DON'T: install or update plugins via the WP admin dashboard
14
+ DO: Add every new environment variable to `.env.example` with a descriptive example value or blank marker — DON'T: commit real secret values in `.env.example`
15
+ DO: Treat `web/wp/` as a Composer-managed read-only directory — DON'T: edit any file under `web/wp/` (overwritten on `composer update`)
16
+ DO: Reference `WP_HOME` and `WP_SITEURL` from env vars in `config/application.php` — DON'T: hardcode URLs in config files
17
+ DO: Use `Config::define()` / `env()` helper for all env var access in config files — DON'T: call `getenv()` or `$_ENV` directly in application code
18
+ DO: Change WP core version by updating `composer.json` and running `composer update roots/wordpress` — DON'T: change WP version by editing files in `web/wp/`
19
+
20
+ ## Forbidden patterns
21
+
22
+ NEVER: Secret or credential value in `config/application.php` — committed to version control; use env vars
23
+ NEVER: Reference `web/wp-content/` path — Bedrock uses `web/app/` as the content directory
24
+ NEVER: WP core version change without running `composer update` — `web/wp/` becomes inconsistent
25
+ NEVER: Plugin activated via WP admin that is not tracked in `composer.json` — disappears on next deploy
26
+ NEVER: `.env` file committed to version control — contains real credentials
27
+ NEVER: `define()` in `web/wp/wp-config.php` — that file is Composer-managed and will be overwritten
@@ -0,0 +1,28 @@
1
+ # Scope
2
+
3
+ ## In-scope files and dirs
4
+
5
+ - `config/application.php` — WP config constants, env loading via `Dotenv`
6
+ - `config/environments/` — per-environment overrides (`development.php`, `staging.php`, `production.php`)
7
+ - `composer.json`, `composer.lock` — PHP dependency management (WP core, plugins, mu-plugins via Packagist/WPackagist)
8
+ - `web/app/` — WordPress web root: `themes/`, `plugins/`, `mu-plugins/`, `uploads/`
9
+ - `web/wp/` — WordPress core (Composer-managed, do not edit)
10
+ - `web/index.php`, `web/wp-config.php` — web entry points (minimal; generated by Bedrock)
11
+ - `.env`, `.env.example` — environment variable files (`DB_*`, `WP_HOME`, `AUTH_KEY`, etc.)
12
+ - `Trellis/` (if present) — Ansible provisioning for Bedrock deployment
13
+
14
+ ## Stack boundaries
15
+
16
+ - Bedrock: env-based config, Composer-managed WP core and plugins, `web/` vs `app/` separation
17
+ - Not in scope: WordPress hook/template logic inside themes/plugins (use wordpress-patterns)
18
+ - Not in scope: ACF/Elementor/JetEngine data layer (use wordpress-acf-elementor-jetengine-patterns)
19
+ - Not in scope: infrastructure provisioning beyond Trellis config
20
+
21
+ ## Triggers
22
+
23
+ - Adding or upgrading a plugin via Composer (not WP admin)
24
+ - Changing WP version constraint in `composer.json`
25
+ - Adding a new constant or config to `config/application.php`
26
+ - Adding environment-specific config override in `config/environments/`
27
+ - Changing `.env` variables (and updating `.env.example`)
28
+ - Adding a mu-plugin or must-use plugin to `web/app/mu-plugins/`
@@ -0,0 +1,42 @@
1
+ # Workflow
2
+
3
+ ## Implementation steps
4
+
5
+ 1. For plugin installs: use Composer — never install via WP admin in Bedrock projects
6
+ 2. Check WPackagist availability: `wpackagist-plugin/plugin-slug` for free WP.org plugins
7
+ 3. Add plugin to `composer.json` under `require`; run `composer install`
8
+ 4. For WP core upgrade: change `roots/wordpress` version constraint; run `composer update roots/wordpress`
9
+ 5. For new config constant: add to `config/application.php`; add env var to `.env` and `.env.example`
10
+ 6. For environment-specific overrides: add to correct file in `config/environments/`
11
+ 7. Verify `WP_HOME` and `WP_SITEURL` are correct for each environment in `.env`
12
+ 8. For Trellis deployment: update `group_vars/` if new env vars added; run `ansible-playbook deploy.yml`
13
+
14
+ ## Commands
15
+
16
+ ```bash
17
+ # Composer (plugin/dependency management)
18
+ composer require wpackagist-plugin/plugin-slug
19
+ composer require wpackagist-theme/theme-slug
20
+ composer update roots/wordpress # upgrade WP core
21
+ composer install # install from lockfile
22
+ composer show # list installed packages
23
+
24
+ # WP-CLI (run inside web root context)
25
+ wp core version # confirm WP version
26
+ wp plugin list # list active plugins
27
+ wp db check # verify DB connection
28
+
29
+ # Trellis provisioning/deployment (if used)
30
+ ansible-playbook server.yml -e env=staging
31
+ ansible-playbook deploy.yml -e env=production -e site=example.com
32
+ ```
33
+
34
+ ## Validation checklist
35
+
36
+ - [ ] No plugin installed via WP admin — only via `composer require`
37
+ - [ ] `composer.lock` committed after every dependency change
38
+ - [ ] `.env.example` updated with any new required env var (without real values)
39
+ - [ ] `WP_HOME` and `WP_SITEURL` correct for each environment
40
+ - [ ] Secrets never committed in `config/*.php` — use `.env` for all sensitive values
41
+ - [ ] `web/wp/` not modified — WordPress core is Composer-managed
42
+ - [ ] mu-plugins added to `web/app/mu-plugins/` — not `web/wp-content/mu-plugins/`
@@ -0,0 +1,161 @@
1
+ ---
2
+ name: writing-documentation
3
+ description: >-
4
+ Creates or refreshes AI-oriented project documentation (CLAUDE.md, docs/SUMMARY.md,
5
+ README pointers, setup/workflow/deployment topic files) for app and workspace repos.
6
+ Use when the user runs /docs or asks to init or sync docs from code for agent context.
7
+ ---
8
+
9
+ # Writing Documentation
10
+
11
+ Produces **agent-operable** docs: `CLAUDE.md` and `docs/SUMMARY.md` as primary entry points; file-path references over copied prose. README links humans into topic files. Client-agnostic — use only the current repo’s names, manifest, and code.
12
+
13
+ ## Use when
14
+
15
+ - The user runs the docs sync (e.g. `/docs`) or asks to initialise or refresh project documentation for agent context.
16
+ - After setup, commands, env, dependencies, deploy, or integrations changed and the docs must catch up.
17
+ - A repo has no `CLAUDE.md`/`docs/` and needs the initial agent-operable doc set.
18
+
19
+ ## Do not use when
20
+
21
+ - The task is a code change with no documentation impact.
22
+ - You would have to invent facts (URLs, hosts, release steps) not present in code/config — mark those gaps with `> CONFIRM-WITH-TEAM:` instead.
23
+ - Editing generated/vendor directories — docs are an index, not a copy of source.
24
+
25
+ ## Integration with haus
26
+
27
+ This skill ships as a default haus catalog skill. When run inside a haus-managed repo:
28
+
29
+ - **Seed from the scanner, don't re-derive.** If `.haus-workflow/context-map.json` exists, read it for roles, stacks, dependencies, and package manager and treat those as given. Spend effort on the deep inventory the shallow scanner cannot produce (wired modules, env→consumer mapping, runtime topology, deploy pipeline).
30
+ - **Preserve the haus import block.** Never alter or drop the `<!-- HAUS:BEGIN haus-imports v=1 -->` … `<!-- HAUS:END haus-imports -->` block in `CLAUDE.md`; write your body around it.
31
+ - **Emit enrichment for asset selection.** After the deep scan, if `.haus-workflow/` exists, write `.haus-workflow/deep-context.json` (best-effort) so haus can recommend skills the shallow scan missed:
32
+
33
+ ```json
34
+ { "source": "writing-documentation", "roles": [], "stacks": {}, "patterns": [] }
35
+ ```
36
+
37
+ **Never add fields beyond this shape** — in particular, never include the repo's absolute path, the user's home directory, or any other machine-specific string (e.g. as a `root`/`scanRoot`/`cwd` field, or embedded inside a `patterns` entry). This file is machine-local and gitignored, but if it ever leaks into git anyway it must never carry another developer's local filesystem path. `source` identifies the writer; `roles`/`stacks`/`patterns` are the signal the recommender actually consumes — no fifth field, and no machine-specific value inside any of these four.
38
+
39
+ Then hint the user: run `haus recommend && haus apply` to pick up newly-discovered skills.
40
+
41
+ - **App mode only under haus.** haus drives single-repo (app mode). Workspace mode is for manual multi-repo use; haus does not orchestrate it.
42
+
43
+ ## Workflow
44
+
45
+ Copy and track:
46
+
47
+ ```text
48
+ Docs Progress
49
+ - [ ] 1. Context scan
50
+ - [ ] 2. Detect mode (app | workspace)
51
+ - [ ] 3. Write/update outputs (templates in references/)
52
+ - [ ] 4. Run references/validation-checklist.md + completeness-criteria.md
53
+ ```
54
+
55
+ ### 1. Context scan
56
+
57
+ Read existing docs, then discover facts from code/config only (no invented URLs, architecture, or release steps).
58
+
59
+ **Always scan**
60
+
61
+ 1. `CLAUDE.md`, `docs/SUMMARY.md`, existing `docs/`
62
+ 2. `README.md`, key config (`package.json`, `composer.json`, CI workflows, `docker-compose.yml`, etc.)
63
+ 3. `GLOSSARY.md` at the repo root if present (index it; it is written by the interview skills, never by this skill) and `docs/research/` if present (list the folder as dated notes; never lift a note into a rule).
64
+ 4. `.env.example` or `.env.sample`
65
+ 5. `git log --oneline -20` when updating
66
+ 6. Test/lint/build scripts and pre-commit hooks (note explicitly if absent)
67
+
68
+ **App mode — discover and document**
69
+
70
+ | Discover | Document in |
71
+ | ------------------------------------------------------------------------------------- | --------------------------------------------- |
72
+ | Bootstrap entry points (`index`, `main`, server, worker, CLI) | `architecture.md`, `codebase.md` |
73
+ | Central wiring/config file(s) | `codebase.md`, `CLAUDE.md` conventions |
74
+ | **Every** top-level module/plugin/package area **and** packages wired only via config | `codebase.md` inventory |
75
+ | Generated dirs (`gql/`, `generated`, etc.) + regen scripts | `development-workflow.md` or `conventions.md` |
76
+ | Migration/schema tooling | `CLAUDE.md`, workflow, architecture |
77
+ | Runtime processes (API + worker + scheduler, etc.) | `architecture.md` |
78
+ | External integrations (CMS, search, queue, email) + env vars | `setup.md`, `architecture.md` |
79
+ | Env vars → consumer (grep config for each key from `.env.example`) | `setup.md` env table |
80
+ | CI deploy pipeline (triggers, build, migrate, verify) | `deployment.md` |
81
+
82
+ **Inventory rule:** If it is registered or imported in central config, it must appear in the codebase map (name, path, one-line purpose). No “major plugins only” sampling.
83
+
84
+ **Workspace mode — discover**
85
+
86
+ 1. `repos.manifest.json`, `repos.local.json.example`, path overrides
87
+ 2. Per-repo pointers only — do not copy app install/deploy tables
88
+ 3. Cross-repo startup order, env alignment, release order (or CONFIRM-WITH-TEAM)
89
+
90
+ ### 2. Detect mode
91
+
92
+ | Mode | Signal |
93
+ | ------------- | ---------------------------------------------------------------- |
94
+ | **App** | Application source in this repo |
95
+ | **Workspace** | Multi-repo orchestration (`repos.manifest.json`, path overrides) |
96
+
97
+ State the mode. Ask if unclear.
98
+
99
+ ### 3. Write outputs
100
+
101
+ **Both modes (always):** `CLAUDE.md`, `README.md`, `docs/SUMMARY.md`
102
+
103
+ **App mode — add when justified** (formats and triggers in `references/topic-file-formats.md`):
104
+
105
+ | File | Typical trigger |
106
+ | ------------------------------ | --------------------------------------------------------- |
107
+ | `docs/setup.md` | Non-trivial local setup or env |
108
+ | `docs/development-workflow.md` | Non-obvious change paths or quality checks |
109
+ | `docs/deployment.md` | CI/CD or remote deploy |
110
+ | `docs/architecture.md` | DB, queue, search, external APIs, or multi-process |
111
+ | `docs/codebase.md` | Application source tree exists |
112
+ | `docs/conventions.md` | Extensions, plugins, custom metadata, workers, or codegen |
113
+
114
+ **Optional app topics** (only when triggered — see `topic-file-formats.md`):
115
+
116
+ `integrations.md`, `testing.md`, `data-model.md`, `security.md`
117
+
118
+ **Workspace mode — glue only** (no per-repo install/deploy copies):
119
+
120
+ `docs/system-overview.md`, `docs/repositories.md`, `docs/local-development.md`, `docs/environments.md`, `docs/release-flow.md`
121
+
122
+ | Owns detail | Content |
123
+ | ----------- | -------------------------------------------------------------- |
124
+ | App repo | Setup, commands, env, architecture, deploy, pre-PR |
125
+ | Workspace | Repo map, integration, cross-repo env alignment, release order |
126
+
127
+ Missing app-repo docs → create in **app repo**, not by expanding workspace docs. Workspace points with `{folder}/path` to config or app docs.
128
+
129
+ **Init:** no `CLAUDE.md` or `docs/` — create full set for mode.
130
+ **Update:** surgical edits; preserve good content; align to current code.
131
+
132
+ ### 4. Validate
133
+
134
+ Run every item in:
135
+
136
+ - `references/validation-checklist.md`
137
+ - `references/completeness-criteria.md`
138
+
139
+ ## References (read per output)
140
+
141
+ | File | Use for |
142
+ | ----------------------------------------- | ------------------------------- |
143
+ | `references/claude-template.md` | `CLAUDE.md` (app mode) |
144
+ | `references/claude-template-workspace.md` | `CLAUDE.md` (workspace mode) |
145
+ | `references/summary-template.md` | `docs/SUMMARY.md` |
146
+ | `references/topic-file-formats.md` | All topic files + optional docs |
147
+ | `references/completeness-criteria.md` | Definition of done |
148
+ | `references/validation-checklist.md` | Final pass |
149
+
150
+ Read the matching reference before writing that output. Do not invent structures the project does not already use.
151
+
152
+ When writing `CLAUDE.md`, use the app or workspace template and include a **keep docs in sync** convention plus PR checklist rows. App repos: update topic docs in-repo. Workspace: update glue docs only; implementation changes stay in app repos.
153
+
154
+ ## Rules
155
+
156
+ - One home per fact; link elsewhere.
157
+ - `{folder}` = manifest folder name or actual repo directory.
158
+ - `> CONFIRM-WITH-TEAM: confirm with team.` for gaps.
159
+ - Concise updates over full rewrites.
160
+ - Ask only when inference fails.
161
+ - Docs are for **routing and decisions**; implementation detail stays in source.
@@ -0,0 +1,60 @@
1
+ # CLAUDE.md template — workspace mode
2
+
3
+ Multi-repo orchestration repos (`repos.manifest.json`, path overrides). **No application source here** — setup, commands, and deploy detail live in app repos. **App repos:** use `claude-template.md`. Keep concise (~150 lines or less).
4
+
5
+ ```markdown
6
+ # [Workspace name]
7
+
8
+ Meta-repo for **multi-repo context**: manifest, integration boundaries, cross-repo env alignment, coordinated release order. **No application source here** — setup, commands, and deploy detail live in app repos (`repos.manifest.json` folders).
9
+
10
+ ## Setup
11
+
12
+ 1. `repos.local.json.example` → `repos.local.json` if app repos are outside this tree (`pathOverrides` keys = manifest `folder` names).
13
+ 2. Or clone per `repos.manifest.json` into workspace root (gitignored).
14
+ 3. [docs/local-development.md](docs/local-development.md) — layout and startup order only.
15
+ 4. Per app repo: [docs/repositories.md](docs/repositories.md) → `{folder}/README.md`, `.env.example`, config (see index table).
16
+
17
+ ## Commands
18
+
19
+ No runtime in this repo. Commands live in each app’s `package.json` / `composer.json` (or equivalent).
20
+
21
+ ## Key conventions
22
+
23
+ - **Agent entry:** `CLAUDE.md` + [docs/SUMMARY.md](docs/SUMMARY.md); load topic files from SUMMARY tables as needed.
24
+ - **Single source of truth:** facts in one repo; workspace docs use `{folder}/path` pointers, not copies of app setup/deploy.
25
+ - Do not commit `repos.local.json`.
26
+ - Cross-repo env alignment: [docs/environments.md](docs/environments.md).
27
+ - **Keep docs in sync (all manifest repos):** after code changes, run the **writing-documentation** skill in every affected repo (this workspace + app repos). App implementation → that repo’s docs; manifest/integration → this workspace. Regenerate `docs/SUMMARY.md` when doc files change in that repo.
28
+
29
+ ## Before opening a PR (workspace)
30
+
31
+ - [ ] `docs/SUMMARY.md` matches files on disk.
32
+ - [ ] Workspace docs reflect this PR (manifest, integration, cross-repo process) or N/A.
33
+ - [ ] No duplicated install/deploy tables from app repos.
34
+ - [ ] New operational detail added in the **app repo** first; pointer here only if cross-cutting
35
+ - [ ] Ran the **writing-documentation** skill in this workspace and in each affected app repo (or N/A)
36
+
37
+ App-repo PR checks: each repo’s `CLAUDE.md` when present.
38
+
39
+ ## Docs
40
+
41
+ [docs/SUMMARY.md](docs/SUMMARY.md)
42
+ ```
43
+
44
+ ## Workspace glue docs (create when justified)
45
+
46
+ Point to these from `docs/SUMMARY.md`; do not copy app-repo install/deploy prose.
47
+
48
+ | File | Owns |
49
+ | --------------------------- | ------------------------------------------------ |
50
+ | `docs/system-overview.md` | Integration boundaries, data flow between repos |
51
+ | `docs/repositories.md` | Repo map, links to each app’s README and config |
52
+ | `docs/local-development.md` | Layout, clone/path overrides, startup order only |
53
+ | `docs/environments.md` | Cross-repo env alignment |
54
+ | `docs/release-flow.md` | Coordinated release order across manifest repos |
55
+
56
+ Missing app-repo detail → create or update in **that app repo**, not by expanding workspace docs.
57
+
58
+ ## Workspace completeness
59
+
60
+ Before finishing, verify `references/completeness-criteria.md` workspace section: repo map complete, startup/release/env documented or CONFIRM-WITH-TEAM, no duplicated app tables.
@@ -0,0 +1,43 @@
1
+ # CLAUDE.md template — app mode
2
+
3
+ Single-codebase repos. **Workspace:** use `claude-template-workspace.md`. Keep concise (~150 lines or less).
4
+
5
+ ```markdown
6
+ # [Project name]
7
+
8
+ [1-2 sentences on repo purpose and role.]
9
+
10
+ ## Setup
11
+
12
+ [Brief prerequisites/install/env. Link to docs/setup.md when it exists.]
13
+
14
+ ## Commands
15
+
16
+ | Command | Action |
17
+ | --------- | ---------------- |
18
+ | `[dev]` | ... |
19
+ | `[build]` | ... |
20
+ | `[test]` | ... |
21
+ | `[check]` | Lint / typecheck |
22
+
23
+ Omit rows that do not exist in package.json (or equivalent).
24
+
25
+ ## Key conventions
26
+
27
+ - [3-8 project-specific bullets from code scan: wiring file, runtime split, schema tool, etc.]
28
+ - **Docs are an index:** use path references in `docs/`; read source for implementation detail.
29
+ - **Regenerate, don't patch:** after schema/API changes, run documented codegen/migration commands — do not hand-edit generated dirs.
30
+ - **Keep docs in sync:** after setup, commands, env, deploy, or integration changes, run the **writing-documentation** skill in **this repo** and commit doc updates with the code change.
31
+
32
+ ## Before opening a PR
33
+
34
+ - [ ] Run available checks (test/lint/build)
35
+ - [ ] Run the **writing-documentation** skill in this repo when setup, commands, env, deploy, or integration changed (or N/A)
36
+ - [ ] Docs reflect this change or explicitly N/A
37
+ - [ ] Run repo-specific steps (migrations, codegen, i18n, etc.) when applicable
38
+ - [ ] Smoke-test impacted flows if no automated coverage
39
+
40
+ ## Docs
41
+
42
+ [docs/SUMMARY.md](docs/SUMMARY.md)
43
+ ```