diff --git a/AGENTS.md b/AGENTS.md index a19dad3436..46f0ff2879 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -12,7 +12,7 @@ repository. | Mermaid diagrams | [MERMAID.md](./readme/MERMAID.md) | | LLM Markdown pipeline | [MARKDOWN_PIPELINE.md](./readme/MARKDOWN_PIPELINE.md) | | Component → Markdown mapping | [COMPONENT_REGISTRY.md](./readme/COMPONENT_REGISTRY.md) | -| CI jobs and scheduled jobs | [AUTOMATIONS.md](./AUTOMATIONS.md) | +| CI jobs and scheduled jobs | [AUTOMATIONS.md](./readme/AUTOMATIONS.md) | ## Repository overview diff --git a/README.md b/README.md index 67f6f6e903..6b2ccbf107 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ This repository contains a large chunk of the Temporal information corpus. | [Readability tooling guidance](./readme/READABILITY.md) | For repo maintainers | | [Style guidance](./readme/STYLE.md) | For our open source community | | [Utility tooling guidance](./readme/UTILITIES.md) | For repo maintainers | +| [Automations inventory](./readme/AUTOMATIONS.md) | For repo maintainers | ### Current component versioning philosophy diff --git a/AUTOMATIONS.md b/readme/AUTOMATIONS.md similarity index 98% rename from AUTOMATIONS.md rename to readme/AUTOMATIONS.md index 630033dbe5..6ff14b2b8f 100644 --- a/AUTOMATIONS.md +++ b/readme/AUTOMATIONS.md @@ -4,7 +4,7 @@ Every automation in this repository, grouped by what triggers it. Use this to fi something new, and to know what to update when you change or rename a job. When you add or rename an automation, update this file and the `workflows:` list in -[`notify-automation-failures.yml`](./.github/workflows/notify-automation-failures.yml). That list matches on a +[`notify-automation-failures.yml`](../.github/workflows/notify-automation-failures.yml). That list matches on a workflow's `name:` value, so a rename silently unhooks its failure alert. ## Content generation @@ -32,7 +32,7 @@ a 404 rather than a 403, so a scope mistake looks like a missing file. | Check Metrics Reference | Changes to `docs/references/sdk-metrics.mdx` | Yes | `check-metrics-reference.yml`, `bin/check-metrics-reference.js` | Checks the page against itself. The comparison with the SDK sources is a separate, advisory job. | | Environment config drift | Changes to the client environment configuration page | Yes | `env-config-drift.yml`, `bin/check-env-config-table.js` | Also runs weekly, because it fetches sources over the network and an outage should not block unrelated pull requests. | | Mermaid CI | Changes under `docs/` | Yes | `mermaid-ci.yml`, `scripts/lint-mermaid.mjs` | Validates diagram syntax across the docs tree. | -| Vale CI | Changes under `docs/` | No | `vale-ci.yml`, `.vale-ci.ini` | Runs only the rules in `.vale-ci.ini`, with `fail_on_error: false` and results limited to changed context. Treat those rules as the bar, not the full style set. See [AGENTS.md](./AGENTS.md#commands). | +| Vale CI | Changes under `docs/` | No | `vale-ci.yml`, `.vale-ci.ini` | Runs only the rules in `.vale-ci.ini`, with `fail_on_error: false` and results limited to changed context. Treat those rules as the bar, not the full style set. See [AGENTS.md](../AGENTS.md#commands). | | Check Orphan Pages | Changes to docs or `sidebars.js` | No | `check-orphan-pages.yml`, `bin/check-orphan-pages.js` | Never fails; comments and annotates only. Accepted exceptions belong in `bin/orphan-pages-baseline.json` with a note. See [UTILITIES.md](./UTILITIES.md#check-orphan-pages). | | Check Metrics Against SDKs | Changes to the metrics page or its checker | No | `check-metrics-against-sdks.yml` | Drift reports but does not fail. On its scheduled runs it manages a tracking issue instead. | | Docs Preview Links | Every pull request | No | `docs-preview-links.yml`, `bin/generate-docs-preview-list.js` | Reads the preview URL out of Vercel's own comment, then upserts a single comment listing the pages the pull request changes. |