docs: Documentation analysis and improvement#805
Draft
github-actions[bot] wants to merge 1 commit intomainfrom
Draft
docs: Documentation analysis and improvement#805github-actions[bot] wants to merge 1 commit intomainfrom
github-actions[bot] wants to merge 1 commit intomainfrom
Conversation
Align architecture overview with current workflow routes in oblt-aw-ingress.yml. 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 #804
Summary of files analyzed
.github/workflows/oblt-aw-ingress.ymldocs/architecture/overview.mdIssues found
docs/architecture/overview.md: Specialized workflows list was incomplete and did not include multiple currently routed workflows from ingress.docs/architecture/overview.md: Routing Model section documented only a subset of active trigger/job routes (mainly dependency-review and resource-not-accessible flows).docs/architecture/overview.md: Examples routing diagram omitted currently routed workflows and no longer represented current ingress behavior.Changes made
docs/architecture/overview.mdto include all workflows currently routed by ingress (agent-suggestions, autodoc, automerge, dependency-review, duplicate-issue-detector, issue-triage, issue-fixer, mention-in-issue, resource-not-accessible-by-integration detector/triage/fixer, and security detector/triage/fixer). This keeps the architecture overview aligned with the ingress source of truth.docs/architecture/overview.mdto reflect current event/action routing conditions, includingschedule,workflow_dispatch,pull_request,issues, andissue_commentpaths plus unsupported-trigger behavior. This removes outdated routing assumptions.docs/architecture/overview.mdto include the full currently routed workflow set. This restores consistency between diagrammed and actual ingress dispatch behavior.What is this? | From workflow: Observability Agentic Workflow Entrypoint
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.