External Artifacts

[AugustMiller]

We often get contributions to files that are partially or entirely generated from source code (like the list of console controllers, or element query params). This seeks to make it clearer what pages (or parts of pages) rely on generated content, by relocating them to a new .artifacts/ directory and using the markdown-it-include library to inline them at build time.

Required Changes

• [x] Buddy Class Reference pipelines:
  • [x] Use $ws/docs/docs/.artifacts/4.x (or 3.x) for the --docs-path argument
  • [x] Commerce should be $ws/docs/docs/.artifacts/commerce/4.x, etc.
• [x] The logic for handling tryPaths can be eliminated, as the paths no longer need to differ between versions:
  • [x] General settings can be written to config-general.md within the --docs-path above (corresponding to the version);
  • [x] Database settings can be written to config-db.md within the --docs-path above (corresponding to the version);
  • [x] Commerce config can be written to config.md within the --docs-path above (corresponding to the version);
• [x] Buddy GraphQL, Console Command, and Event Reference pipelines (v3 + v4):
  • [x] GraphQL: docubot/gql/generate --targetFile=$ws/docs/docs/.artifacts/4.x;
  • [x] Commands: docubot/commands --targetFile=$ws/docs/docs/.artifacts/4.x;
  • [x] Event Reference: docubot/event-dumper --targetFile=$ws/docs/docs/.artifacts/4.x;
• [ ] …

Cautionary Notes

• ElementQuery subclasses have a @doc-path tag that we probably shouldn't touch at this stage. It would be nice if there was zero outside influence on where these things ended up, but there is some precedent with config setting groups.

[netlify[bot]]

✅ Deploy Preview for craft-docs ready!

Name	Link
🔨 Latest commit	946e9c702aec8ffcf49d7e72485fa57aa64655da
🔍 Latest deploy log	https://app.netlify.com/sites/craft-docs/deploys/6571ec3cd6d73800086b7f5b
😎 Deploy Preview	https://deploy-preview-552--craft-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[AugustMiller]

Updating Craft CMS artifacts to use a cms subpath to agree with the commerce subpath. This is a change I would like to make for the main docsets, at some point—but it would be too disruptive to routing, at the moment.