Skip to content

Wrap docs-issue-scope body updates in a collapsible section #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
theletterf merged 1 commit into from
Apr 14, 2026
Merged

Wrap docs-issue-scope body updates in a collapsible section #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 25 additions & 15 deletions .github/workflows/gh-aw-docs-issue-scope.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 14 additions & 4 deletions .github/workflows/gh-aw-docs-issue-scope.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,10 +216,13 @@ Prefer `update_issue` as the primary output when the triggering item is an issue
Use this exact body-block format inside the managed markers:

```
## Docs issue scope

<!-- docs-issue-scope:start -->

## AI scoping 🤖

<details>
<summary>Docs issue scope</summary>

### Summary
<1 short paragraph separating what the issue asks for from what the linked code changes show.>

Expand Down Expand Up @@ -251,6 +254,8 @@ Use this exact body-block format inside the managed markers:

<One short bullet or sentence per recommendation explaining the page role, content-type fit, or follow-on assembly work only when it materially affects the recommendation.>

</details>

<!-- docs-issue-scope:end -->
```

Expand All @@ -268,10 +273,13 @@ When you do need `add_comment`, keep it brief and point the reader to the issue
If the request does not have enough information, use this shorter managed block for issue-body updates:

```
## Docs issue scope

<!-- docs-issue-scope:start -->

## AI scoping 🤖

<details>
<summary>Docs issue scope</summary>

### Next action for author
Add more issue detail or link the relevant public PRs or commits, then rerun `/docs-issue-scope`.

Expand All @@ -282,6 +290,8 @@ Add more issue detail or link the relevant public PRs or commits, then rerun `/d
1. <Relevant PR or commit links.>
2. <A short description of the user-facing change or docs definition of done.>

</details>

<!-- docs-issue-scope:end -->
```

Expand Down
4 changes: 2 additions & 2 deletions agentic-workflows/docs-issue-scope/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Docs Issue Scope

Uses an issue description plus linked public PRs and commits to scope Elastic documentation work. When the command runs on an issue, it maintains a concise bot-managed scope block in the issue body when that can be done safely. Otherwise, it falls back to a concise comment with recommended doc targets and next steps.
Uses an issue description plus linked public PRs and commits to scope Elastic documentation work. When the command runs on an issue, it maintains a concise bot-managed scope block in the issue body when that can be done safely. The managed block is published under an `AI scoping 🤖` heading, and the details are wrapped in a collapsible section to keep the issue body compact. Otherwise, it falls back to a concise comment with recommended doc targets and next steps.

## Triggers

Expand Down Expand Up @@ -45,7 +45,7 @@ When `/docs-issue-scope` runs on an issue, the workflow prefers to maintain a bo
- `<!-- docs-issue-scope:start -->`
- `<!-- docs-issue-scope:end -->`

If the markers already exist exactly once, the workflow rewrites only that block. If the markers are missing, it appends a new block. If the markers are malformed or duplicated, it does not overwrite the issue body and falls back to a concise comment instead.
If the markers already exist exactly once, the workflow rewrites only that block. If the markers are missing, it appends a new block. The managed block includes an `AI scoping 🤖` heading followed by a GitHub `<details>` section. If the markers are malformed or duplicated, it does not overwrite the issue body and falls back to a concise comment instead.

## Example

Expand Down
Loading