docs: Documentation analysis and improvement#1092
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1091
Summary of files analyzed
.github/workflows/distribute-client-workflow.ymlscripts/build_target_operations.py.github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-pr-ai-menu.yml.github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-pr-ai-menu-collect.ymldocs/operations/distribute-client-workflow.mddocs/workflows/distribute-client-workflow.mddocs/workflows/docs-aw-pr-ai-menu.mdIssues found
docs/operations/distribute-client-workflow.md: trigger path list omitted two activepushpaths (.github/workflows/distribute-client-workflow.yml,scripts/build_target_operations.py).docs/workflows/distribute-client-workflow.md: prerequisites trigger list omitted the same two activepushpaths.docs/operations/distribute-client-workflow.md: documented script outputs omittedrelevant_git_changes, which is emitted bybuild_target_operations.pyand consumed in workflow summary output.docs/workflows/distribute-client-workflow.md: target-builder output contract omittedrelevant_git_changes.docs/workflows/docs-aw-pr-ai-menu.md: overview/prerequisites still described PR-event triggering as a single-template flow, not the current split collect (pull_request) + privileged (workflow_run/issue_comment/workflow_dispatch) model.Changes made
docs/operations/distribute-client-workflow.mdtrigger docs to include.github/workflows/distribute-client-workflow.ymlandscripts/build_target_operations.pyso the documentedpushcontract matches the workflow source of truth.docs/workflows/distribute-client-workflow.mdprerequisites with the same two trigger paths for consistency between workflow and operations docs.relevant_git_changesto the output contract in both distribution docs, including concise boolean semantics, so readers can correctly interpret target-builder outputs and summary behavior.docs/workflows/docs-aw-pr-ai-menu.mdoverview and prerequisites to describe the split trigger architecture (trigger-docs-aw-pr-ai-menu-collect.ymlforpull_request,trigger-docs-aw-pr-ai-menu.ymlfor privileged routing and workflow_call) to match current client template behavior.What is this? | From workflow: Observability Agentic Workflow — Autodoc
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.