fix: remove bold tags from details/summary sections#24502
Conversation
…24489) Agent-Logs-Url: https://github.com/github/gh-aw/sessions/f74d7586-5773-402a-9fe9-b5ab0707b70e Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR removes redundant <b> tags from <summary> elements inside GitHub-rendered <details> blocks to avoid double-bold rendering and keep formatting guidance consistent.
Changes:
- Updated JS generators to emit
<summary>…</summary>(without<b>) and adjusted associated test expectations. - Updated Markdown templates/instruction docs to remove guidance/examples that wrap
<summary>text in<b>. - Updated workflow prompt markdown files to remove
<b>from inline<summary>examples used as formatting guidance.
Show a summary per file
| File | Description |
|---|---|
| scratchpad/token-budget-guidelines.md | Updates example <details>/<summary> snippets to remove <b> wrapping. |
| scratchpad/gastown.md | Updates report-format example to remove <b> from <summary>. |
| pkg/workflow/testdata/wasm_golden/fixtures/shared/reporting.md | Updates golden fixture guidance/examples to remove <b> from <summary>. |
| pkg/workflow/.github/aw/imports/githubnext/agentics/d3422bf940923ef1d43db5559652b8e1e71869f3/workflows_shared_reporting.md | Updates imported reporting guidance/examples to remove <b> requirement. |
| actions/setup/md/noop_runs_issue.md | Removes <b> from <summary> in the noop issue template. |
| actions/setup/md/manifest_protection_push_to_pr_fallback.md | Removes <b> from <summary> in the fallback instructions template. |
| actions/setup/md/manifest_protection_push_failed_fallback.md | Removes <b> from <summary> in the fallback instructions template. |
| actions/setup/md/agent_failure_issue.md | Removes <b> from <summary> sections in the agent-failure issue template. |
| actions/setup/js/parse_mcp_gateway_log.test.cjs | Updates assertions to expect non-<b> <summary> output. |
| actions/setup/js/parse_mcp_gateway_log.cjs | Removes <b> from generated <summary> strings in gateway log summaries. |
| actions/setup/js/missing_info_formatter.test.cjs | Updates assertions to expect non-<b> <summary> output. |
| actions/setup/js/missing_info_formatter.cjs | Removes <b> from generated <summary> strings for missing info sections. |
| actions/setup/js/handle_noop_message.test.cjs | Updates expected noop issue body to remove <b> from <summary>. |
| actions/setup/js/handle_agent_failure.cjs | Removes <b> from generated <summary> strings in failure context blocks. |
| actions/setup/js/generate_observability_summary.test.cjs | Updates assertion to expect non-<b> <summary> output. |
| actions/setup/js/generate_observability_summary.cjs | Removes <b> from generated <summary> in observability summary. |
| actions/setup/js/gateway_difc_filtered.test.cjs | Updates assertions to expect non-<b> <summary> output. |
| actions/setup/js/gateway_difc_filtered.cjs | Removes <b> from generated <summary> in DIFC filtered note section. |
| .github/workflows/workflow-skill-extractor.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/workflow-normalizer.md | Updates <summary> example to remove <b> (but leaves conflicting “make summaries bold” guidance). |
| .github/workflows/weekly-safe-outputs-spec-review.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/weekly-editors-health-check.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/typist.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/step-name-alignment.md | Removes <b> from <summary> formatting instruction. |
| .github/workflows/smoke-claude.lock.yml | Updates embedded reporting guidance/examples to remove <b> from <summary>. |
| .github/workflows/shared/reporting.md | Updates shared reporting guidance/examples to remove <b> from <summary>. |
| .github/workflows/sergo.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/scout.md | Removes <b> from <summary> formatting instruction and example. |
| .github/workflows/repository-quality-improver.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/repo-audit-analyzer.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/prompt-clustering-analysis.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/pr-triage-agent.md | Removes <b> from <summary> formatting instruction and examples. |
| .github/workflows/pr-nitpick-reviewer.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/portfolio-analyst.md | Removes <b> from multiple <summary> examples used in prompt guidance. |
| .github/workflows/org-health-report.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/issue-triage-agent.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/github-mcp-structural-analysis.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/draft-pr-cleanup.md | Removes <b> from <summary> formatting instruction and examples. |
| .github/workflows/developer-docs-consolidator.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/dev-hawk.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/delight.md | Removes <b> from <summary> formatting instruction. |
| .github/workflows/daily-workflow-updater.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/daily-testify-uber-super-expert.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/daily-team-evolution-insights.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/daily-syntax-error-quality.md | Removes <b> from <summary> examples that include score text. |
| .github/workflows/daily-secrets-analysis.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/daily-safe-outputs-conformance.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/daily-safe-output-optimizer.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/daily-regulatory.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/daily-performance-summary.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/daily-observability-report.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/daily-news.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/daily-multi-device-docs-tester.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/daily-mcp-concurrency-analysis.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/daily-issues-report.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/daily-integrity-analysis.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/daily-function-namer.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/daily-firewall-report.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/daily-file-diet.md | Removes <b> from <summary> formatting instruction and examples. |
| .github/workflows/daily-doc-updater.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/daily-doc-healer.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/daily-copilot-token-report.md | Removes <b> from <summary> formatting instruction and examples. |
| .github/workflows/daily-compiler-quality.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/daily-code-metrics.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/daily-cli-performance.md | Removes <b> from <summary> strings written by embedded script. |
| .github/workflows/copilot-pr-merged-report.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/copilot-cli-deep-research.md | Removes <b> from multiple <summary> examples used in prompt guidance. |
| .github/workflows/contribution-check.md | Removes <b> from <summary> formatting instruction and example. |
| .github/workflows/constraint-solving-potd.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/cli-version-checker.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/cli-consistency-checker.md | Removes <b> from <summary> formatting instruction and example. |
| .github/workflows/claude-code-user-docs-review.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/ci-doctor.md | Removes <b> from <summary> guidance/examples (notably “Analysis Steps”). |
| .github/workflows/ci-coach.md | Removes <b> from <summary> example used in prompt guidance. |
| .github/workflows/breaking-change-checker.md | Removes <b> from <summary> examples used in prompt guidance. |
| .github/workflows/bot-detection.md | Removes <b> from <summary> formatting instruction. |
| .github/workflows/auto-triage-issues.md | Removes <b> from <summary> formatting instruction and examples. |
| .github/workflows/archie.md | Removes <b> from <summary> guidance and example. |
| .github/workflows/agent-persona-explorer.md | Removes <b> from <summary> formatting instruction and examples. |
| .github/aw/report.md | Updates reporting guidance/examples to remove <b> from <summary>. |
| .github/aw/imports/githubnext/agentics/d3422bf940923ef1d43db5559652b8e1e71869f3/workflows_shared_reporting.md | Updates imported reporting guidance/examples to remove <b> requirement. |
| .github/aw/create-agentic-workflow.md | Updates authoring guidelines example to remove <b> from <summary>. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 82/82 changed files
- Comments generated: 2
| 2. **Progressive Disclosure**: Use HTML `<details>` and `<summary>` tags to collapse long content | ||
| - ❌ Bad: Long lists of items that force scrolling | ||
| - ✅ Good: `<details><summary><b>View Full Details</b></summary>` wrapping content | ||
| - ✅ Good: `<details><summary>View Full Details</summary>` wrapping content | ||
| - Make summaries bold: `<b>Text</b>` |
There was a problem hiding this comment.
The style guideline still instructs making summaries bold via <b> (line 58), which contradicts the rest of this PR’s change (removing <b> from <summary> because GitHub already bold-styles it). Please remove this bullet or rewrite it to state that <summary> is already styled and should not be wrapped in <b>.
| - **Headers**: Start at h3 (###) to maintain proper document hierarchy | ||
| - **Checkboxes**: Use `- [ ]` for unchecked and `- [x]` for checked task items | ||
| - **Progressive Disclosure**: Use `<details><summary><b>Bold Summary Text</b></summary>` to collapse long content | ||
| - **Progressive Disclosure**: Use `<details><summary>Bold Summary Text</summary>` to collapse long content |
There was a problem hiding this comment.
This example now says Use <details><summary>Bold Summary Text</summary> but the text is no longer bold and the phrase can imply authors should still force bold styling. Consider changing the placeholder to something like Section Name / Summary Text to avoid reintroducing <b> usage.
| - **Progressive Disclosure**: Use `<details><summary>Bold Summary Text</summary>` to collapse long content | |
| - **Progressive Disclosure**: Use `<details><summary>Section Name</summary>` to collapse long content |
<summary>elements in GitHub-rendered<details>blocks are already styled as interactive disclosure widgets — wrapping content in<b>tags produced redundant double-bold rendering.Changes
actions/setup/js/*.cjs): removed<b>/</b>from all hardcoded<summary>strings inparse_mcp_gateway_log,missing_info_formatter,handle_agent_failure,generate_observability_summary,gateway_difc_filteredactions/setup/md/*.md): removed bold tags from static<summary>content in noop/agent-failure/manifest-protection issue templates.github/aw/report.md,shared/reporting.md,create-agentic-workflow.md, imports): updated examples and removed the instruction to wrap summary text in<b>tags.github/workflows/*.md): stripped bold from inline<summary>examples used as AI formatting guidanceBefore / After: