cc @elastic/observablt-ci
Recent documentation audit found concrete documentation drift that can mislead maintainers and consumers.
Changes Requiring Documentation Updates
1. ESTC Buildkite Detective docs reference a nonexistent client template
What changed / evidence: docs/workflows/oblt-aw-estc-pr-buildkite-detective.md:7 and docs/workflows/oblt-aw-estc-pr-buildkite-detective.md:11 say the workflow is called from trigger-oblt-aw-estc-pr-buildkite-detective.yml, but that file does not exist in the repository. The actual distributed status template is .github/remote-workflow-template/obs/.github/workflows/trigger-oblt-aw-status.yml:1, which calls .github/workflows/oblt-aw-event-status.yml:20 and then .github/workflows/oblt-aw-estc-pr-buildkite-detective.yml:37.
Documentation impact: Consumers looking for or configuring the documented client template will search for a file that is not shipped.
2. Multi-org architecture docs document an unsupported registry display field
What changed / evidence: docs/architecture/multi-org-agentic-workflows.md:133 says workflow entries can include optional display_name. The dashboard renderer reads name instead: scripts/sync_control_plane_dashboard.py:168-174 and scripts/sync_control_plane_dashboard.py:184-192 use wf.get("name", wf_id). Current registries also use name, for example config/obs/workflow-registry.json:5-7.
Documentation impact: Maintainers adding display_name based on the architecture docs would not see it rendered in the dashboard.
3. Multi-org architecture docs omit workflow-token-policy from the repos matrix shape
What changed / evidence: docs/architecture/multi-org-agentic-workflows.md:122-125 documents build_repos_matrix.py output repos as [{"repository":"owner/repo"}, ...]. The script emits workflow-token-policy for every matrix row: scripts/build_repos_matrix.py:23-24 documents {"repository": "owner/repo", "workflow-token-policy": "..."}, and scripts/build_repos_matrix.py:50-54 builds that shape.
Documentation impact: Operators debugging dashboard sync matrix output or token policy propagation see an incomplete documented contract.
Suggested Actions
What is this? | From workflow: Observability Agentic Workflow — Schedule
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
cc
@elastic/observablt-ciRecent documentation audit found concrete documentation drift that can mislead maintainers and consumers.
Changes Requiring Documentation Updates
1. ESTC Buildkite Detective docs reference a nonexistent client template
What changed / evidence:
docs/workflows/oblt-aw-estc-pr-buildkite-detective.md:7anddocs/workflows/oblt-aw-estc-pr-buildkite-detective.md:11say the workflow is called fromtrigger-oblt-aw-estc-pr-buildkite-detective.yml, but that file does not exist in the repository. The actual distributed status template is.github/remote-workflow-template/obs/.github/workflows/trigger-oblt-aw-status.yml:1, which calls.github/workflows/oblt-aw-event-status.yml:20and then.github/workflows/oblt-aw-estc-pr-buildkite-detective.yml:37.Documentation impact: Consumers looking for or configuring the documented client template will search for a file that is not shipped.
2. Multi-org architecture docs document an unsupported registry display field
What changed / evidence:
docs/architecture/multi-org-agentic-workflows.md:133says workflow entries can include optionaldisplay_name. The dashboard renderer readsnameinstead:scripts/sync_control_plane_dashboard.py:168-174andscripts/sync_control_plane_dashboard.py:184-192usewf.get("name", wf_id). Current registries also usename, for exampleconfig/obs/workflow-registry.json:5-7.Documentation impact: Maintainers adding
display_namebased on the architecture docs would not see it rendered in the dashboard.3. Multi-org architecture docs omit
workflow-token-policyfrom the repos matrix shapeWhat changed / evidence:
docs/architecture/multi-org-agentic-workflows.md:122-125documentsbuild_repos_matrix.pyoutputreposas[{"repository":"owner/repo"}, ...]. The script emitsworkflow-token-policyfor every matrix row:scripts/build_repos_matrix.py:23-24documents{"repository": "owner/repo", "workflow-token-policy": "..."}, andscripts/build_repos_matrix.py:50-54builds that shape.Documentation impact: Operators debugging dashboard sync matrix output or token policy propagation see an incomplete documented contract.
Suggested Actions
docs/workflows/oblt-aw-estc-pr-buildkite-detective.mdto describe the actual route:trigger-oblt-aw-status.yml->oblt-aw-event-status.yml->oblt-aw-estc-pr-buildkite-detective.yml.docs/architecture/multi-org-agentic-workflows.mdto replacedisplay_namewith the supported workflow entry fieldname, and note thatsection_titleis the optional top-level registry display label.docs/architecture/multi-org-agentic-workflows.mdto documentbuild_repos_matrix.pyreposrows as including bothrepositoryandworkflow-token-policy, withworkflow-token-policyset to an empty string when unset.What is this? | From workflow: Observability Agentic Workflow — Schedule
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.