From 126f5168fea93739e5c30d366bc6e6f5f4b6e883 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 22 Jul 2026 15:56:36 +0000 Subject: [PATCH] Add reusable AI dictionary guidance to terminology workflows Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --- .github/workflows/daily-doc-updater.lock.yml | 24 +++++++------ .github/workflows/daily-doc-updater.md | 2 ++ .../workflows/glossary-maintainer.lock.yml | 24 +++++++------ .github/workflows/glossary-maintainer.md | 3 ++ .../workflows/shared/ai-coding-dictionary.md | 34 +++++++++++++++++++ .../workflows/step-name-alignment.lock.yml | 20 ++++++----- .github/workflows/step-name-alignment.md | 6 ++++ .../workflows/technical-doc-writer.lock.yml | 24 +++++++------ .github/workflows/technical-doc-writer.md | 2 ++ 9 files changed, 97 insertions(+), 42 deletions(-) create mode 100644 .github/workflows/shared/ai-coding-dictionary.md diff --git a/.github/workflows/daily-doc-updater.lock.yml b/.github/workflows/daily-doc-updater.lock.yml index edf0a39b8f7..4bbb22fb54e 100644 --- a/.github/workflows/daily-doc-updater.lock.yml +++ b/.github/workflows/daily-doc-updater.lock.yml @@ -1,4 +1,4 @@ -# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"3a911f16d5bd9b46b6cf09029d4852dc4b250fc7ff6213f7f6b0b63476f78ad8","body_hash":"c0456b27237c17a40b7553d2fff425b5fcd19314e8ca45340391718370045ddc","strict":true,"agent_id":"pi","agent_model":"copilot/gpt-5.4","engine_versions":{"pi":"0.80.10"}} +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"a6cf80b2a28113723144b12dabd2983c9179ce96fe80e531e935591637603fc0","body_hash":"a0c85d1e88615041b95827b750cd12fd41af3c23c65f18e74fbec408ced7a681","strict":true,"agent_id":"pi","agent_model":"copilot/gpt-5.4","engine_versions":{"pi":"0.80.10"}} # gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_CI_TRIGGER_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GH_AW_OTEL_GRAFANA_AUTHORIZATION","GH_AW_OTEL_GRAFANA_ENDPOINT","GH_AW_OTEL_SENTRY_AUTHORIZATION","GH_AW_OTEL_SENTRY_ENDPOINT","GITHUB_TOKEN"],"actions":[{"repo":"actions/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7.0.0"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.37","digest":"sha256:0d35e8682845f183c1c634699a8e8a6cbe2c271b867031410df74533243c5f67","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.37@sha256:0d35e8682845f183c1c634699a8e8a6cbe2c271b867031410df74533243c5f67"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.37","digest":"sha256:fc2970aadaeae05993e76697d29f03dc8bfb9248ff87a8f3d8b0975485a4b317","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.37@sha256:fc2970aadaeae05993e76697d29f03dc8bfb9248ff87a8f3d8b0975485a4b317"},{"image":"ghcr.io/github/gh-aw-firewall/cli-proxy:0.27.37","digest":"sha256:1d5300d9b08e1c4f2ad1830860656a0656383a83280058f17e805a7c3ecda203","pinned_image":"ghcr.io/github/gh-aw-firewall/cli-proxy:0.27.37@sha256:1d5300d9b08e1c4f2ad1830860656a0656383a83280058f17e805a7c3ecda203"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.37","digest":"sha256:5abc51995e5901c5d1daeefc957301ee409980e2e607391ec22c06cb2513327b","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.37@sha256:5abc51995e5901c5d1daeefc957301ee409980e2e607391ec22c06cb2513327b"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} # This file was automatically generated by gh-aw. DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md # @@ -27,6 +27,7 @@ # # Resolved workflow manifest: # Imports: +# - shared/ai-coding-dictionary.md # - shared/github-guard-policy.md # - shared/otlp.md # @@ -308,24 +309,24 @@ jobs: run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_e622f98c736d1307_EOF' + cat << 'GH_AW_PROMPT_5858a2cbda96b9e0_EOF' - GH_AW_PROMPT_e622f98c736d1307_EOF + GH_AW_PROMPT_5858a2cbda96b9e0_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/cache_memory_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_e622f98c736d1307_EOF' + cat << 'GH_AW_PROMPT_5858a2cbda96b9e0_EOF' Tools: create_pull_request, missing_tool, missing_data, noop - GH_AW_PROMPT_e622f98c736d1307_EOF + GH_AW_PROMPT_5858a2cbda96b9e0_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_create_pull_request.md" - cat << 'GH_AW_PROMPT_e622f98c736d1307_EOF' + cat << 'GH_AW_PROMPT_5858a2cbda96b9e0_EOF' - GH_AW_PROMPT_e622f98c736d1307_EOF + GH_AW_PROMPT_5858a2cbda96b9e0_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_e622f98c736d1307_EOF' + cat << 'GH_AW_PROMPT_5858a2cbda96b9e0_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -354,14 +355,15 @@ jobs: {{/if}} - GH_AW_PROMPT_e622f98c736d1307_EOF + GH_AW_PROMPT_5858a2cbda96b9e0_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/cli_proxy_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_e622f98c736d1307_EOF' + cat << 'GH_AW_PROMPT_5858a2cbda96b9e0_EOF' {{#runtime-import .github/workflows/shared/github-guard-policy.md}} + {{#runtime-import .github/workflows/shared/ai-coding-dictionary.md}} {{#runtime-import .github/workflows/shared/otlp.md}} {{#runtime-import .github/workflows/daily-doc-updater.md}} - GH_AW_PROMPT_e622f98c736d1307_EOF + GH_AW_PROMPT_5858a2cbda96b9e0_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 diff --git a/.github/workflows/daily-doc-updater.md b/.github/workflows/daily-doc-updater.md index b42554bcc17..4c36f0d9012 100644 --- a/.github/workflows/daily-doc-updater.md +++ b/.github/workflows/daily-doc-updater.md @@ -15,6 +15,7 @@ network: - github imports: - shared/github-guard-policy.md +- shared/ai-coding-dictionary.md - shared/otlp.md safe-outputs: create-pull-request: @@ -98,6 +99,7 @@ Scan the repository for merged pull requests and code changes from the last 24 h - **GitHub data (detailed reads)**: use GitHub MCP tools (`search_pull_requests`, `pull_request_read`, `list_commits`, `get_commit`) for per-item detail lookups in Task Steps - **Do NOT** use `mcpscripts` for any GitHub reads — use `gh` CLI or GitHub MCP tools directly - **Documentation editing**: use the `Edit` tool, not bash `sed` +- **AI terminology normalization**: use the shared AI Coding Dictionary reference to keep AI-coding terms consistent ## Pre-flight: Batch Data Fetch (do this first, before any analysis) diff --git a/.github/workflows/glossary-maintainer.lock.yml b/.github/workflows/glossary-maintainer.lock.yml index db08d9b1e88..652d8c91d48 100644 --- a/.github/workflows/glossary-maintainer.lock.yml +++ b/.github/workflows/glossary-maintainer.lock.yml @@ -1,4 +1,4 @@ -# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"8cd045d87a513fb1f2bfdb79df34f828931b5563157834dc7239e5669e385717","body_hash":"cc2279ea089cb5b447dc5602baea7867fd7150efb5be1bd370934811d6e6a4a0","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"eb5bb0501bc352997ac662dc1d2002d351d64d70b8bef83f6232ea14a30410f2","body_hash":"0bd4dfe334284eab764a30ce0b01f22675e67e142145634fd490ffd50279eb88","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} # gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_CI_TRIGGER_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GH_AW_OTEL_GRAFANA_AUTHORIZATION","GH_AW_OTEL_GRAFANA_ENDPOINT","GH_AW_OTEL_SENTRY_AUTHORIZATION","GH_AW_OTEL_SENTRY_ENDPOINT","GITHUB_TOKEN"],"actions":[{"repo":"actions/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7.0.0"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.37","digest":"sha256:0d35e8682845f183c1c634699a8e8a6cbe2c271b867031410df74533243c5f67","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.37@sha256:0d35e8682845f183c1c634699a8e8a6cbe2c271b867031410df74533243c5f67"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.37","digest":"sha256:fc2970aadaeae05993e76697d29f03dc8bfb9248ff87a8f3d8b0975485a4b317","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.37@sha256:fc2970aadaeae05993e76697d29f03dc8bfb9248ff87a8f3d8b0975485a4b317"},{"image":"ghcr.io/github/gh-aw-firewall/cli-proxy:0.27.37","digest":"sha256:1d5300d9b08e1c4f2ad1830860656a0656383a83280058f17e805a7c3ecda203","pinned_image":"ghcr.io/github/gh-aw-firewall/cli-proxy:0.27.37@sha256:1d5300d9b08e1c4f2ad1830860656a0656383a83280058f17e805a7c3ecda203"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.37","digest":"sha256:5abc51995e5901c5d1daeefc957301ee409980e2e607391ec22c06cb2513327b","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.37@sha256:5abc51995e5901c5d1daeefc957301ee409980e2e607391ec22c06cb2513327b"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"},{"image":"ghcr.io/github/serena-mcp-server:latest","digest":"sha256:bf343399e3725c45528f531a230f3a04521d4cdef29f9a5af6282ff0d3c393c5","pinned_image":"ghcr.io/github/serena-mcp-server:latest@sha256:bf343399e3725c45528f531a230f3a04521d4cdef29f9a5af6282ff0d3c393c5"}]} # This file was automatically generated by gh-aw. DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md # @@ -29,6 +29,7 @@ # Imports: # - ../agents/technical-doc-writer.agent.md # - ../skills/documentation/SKILL.md +# - shared/ai-coding-dictionary.md # - shared/mcp/serena-go.md # - shared/mcp/serena.md # - shared/otlp.md @@ -274,25 +275,25 @@ jobs: run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_fa971e2710f4fa52_EOF' + cat << 'GH_AW_PROMPT_64b24ae84dccdb2f_EOF' - GH_AW_PROMPT_fa971e2710f4fa52_EOF + GH_AW_PROMPT_64b24ae84dccdb2f_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/cache_memory_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/repo_memory_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_fa971e2710f4fa52_EOF' + cat << 'GH_AW_PROMPT_64b24ae84dccdb2f_EOF' Tools: create_pull_request, missing_tool, missing_data, noop - GH_AW_PROMPT_fa971e2710f4fa52_EOF + GH_AW_PROMPT_64b24ae84dccdb2f_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_create_pull_request.md" - cat << 'GH_AW_PROMPT_fa971e2710f4fa52_EOF' + cat << 'GH_AW_PROMPT_64b24ae84dccdb2f_EOF' - GH_AW_PROMPT_fa971e2710f4fa52_EOF + GH_AW_PROMPT_64b24ae84dccdb2f_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_fa971e2710f4fa52_EOF' + cat << 'GH_AW_PROMPT_64b24ae84dccdb2f_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -334,19 +335,20 @@ jobs: stop immediately and report the limitation rather than spending turns trying to work around it. - GH_AW_PROMPT_fa971e2710f4fa52_EOF + GH_AW_PROMPT_64b24ae84dccdb2f_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/cli_proxy_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_fa971e2710f4fa52_EOF' + cat << 'GH_AW_PROMPT_64b24ae84dccdb2f_EOF' {{#runtime-import .github/skills/documentation/SKILL.md}} {{#runtime-import .github/agents/technical-doc-writer.agent.md}} + {{#runtime-import .github/workflows/shared/ai-coding-dictionary.md}} {{#runtime-import .github/workflows/shared/mcp/serena-go.md}} {{#runtime-import .github/workflows/shared/otlp.md}} ## Serena Code Analysis Serena is enabled for **["go"]** in `__GH_AW_GITHUB_WORKSPACE__`. Start by calling `activate_project` with that workspace path, then prefer Serena semantic tools for symbol lookup, references, docs, diagnostics, and structured edits. {{#runtime-import .github/workflows/glossary-maintainer.md}} - GH_AW_PROMPT_fa971e2710f4fa52_EOF + GH_AW_PROMPT_64b24ae84dccdb2f_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 diff --git a/.github/workflows/glossary-maintainer.md b/.github/workflows/glossary-maintainer.md index 6fc37b2a8ff..51f8d459406 100644 --- a/.github/workflows/glossary-maintainer.md +++ b/.github/workflows/glossary-maintainer.md @@ -27,6 +27,7 @@ network: imports: - ../skills/documentation/SKILL.md - ../agents/technical-doc-writer.agent.md + - shared/ai-coding-dictionary.md - shared/mcp/serena-go.md - shared/otlp.md @@ -107,6 +108,7 @@ Keep the glossary up-to-date by: 2. Performing incremental updates daily (last 24 hours) 3. Performing comprehensive full scan on Mondays (last 7 days) 4. Adding new terms and updating definitions based on repository changes +5. Aligning AI-coding terminology with the shared AI Coding Dictionary reference ## Available Tools @@ -187,6 +189,7 @@ The current glossary was already read in Step 1 along with the scope files. - Terms that need updated definitions - Outdated terminology - Inconsistent definitions +- Generic AI terms that should be normalized using the shared AI Coding Dictionary reference ### 5. Follow Documentation Guidelines diff --git a/.github/workflows/shared/ai-coding-dictionary.md b/.github/workflows/shared/ai-coding-dictionary.md new file mode 100644 index 00000000000..50d7cc06d56 --- /dev/null +++ b/.github/workflows/shared/ai-coding-dictionary.md @@ -0,0 +1,34 @@ +--- +# Shared AI coding terminology reference for workflow prompts. +# +# Source: https://github.com/mattpocock/dictionary-of-ai-coding +# Purpose: Keep AI-coding terminology consistent across workflow outputs. +--- + +# AI Coding Dictionary Reference + +Use the AI Coding Dictionary as a secondary terminology authority: + +- Source: https://github.com/mattpocock/dictionary-of-ai-coding +- Website: https://aicodingdictionary.com + +## Reusable Summary + +The dictionary organizes terminology across these areas: + +1. **The model** (model, tokens, inference, provider requests, cache tokens) +2. **Sessions and context** (context window, system prompt, turn, stateless/stateful) +3. **Tools and environment** (tool call/result, MCP, sandbox, permission modes) +4. **Failure modes** (hallucination, attention degradation, knowledge cutoff) +5. **Handoffs** (primary/secondary sources, handoff artifacts, compaction) +6. **Memory and steering** (memory systems, AGENTS.md, progressive disclosure, skills, subagents) +7. **Patterns of work** (human-in-the-loop, review patterns, prototyping, DX/AX) + +## Usage Rules + +- Prefer repository-specific terminology from `docs/src/content/docs/reference/glossary.md` when there is a conflict. +- Use this dictionary to disambiguate generic AI terms and reduce wording drift across docs and workflow output. +- When introducing or revising AI-coding terms, include a short "AI dictionary alignment summary" in your notes/PR description with: + - terms reviewed + - terms adopted + - conflicts resolved (if any) diff --git a/.github/workflows/step-name-alignment.lock.yml b/.github/workflows/step-name-alignment.lock.yml index dc37e6fa5aa..4bc5a823c6f 100644 --- a/.github/workflows/step-name-alignment.lock.yml +++ b/.github/workflows/step-name-alignment.lock.yml @@ -1,4 +1,4 @@ -# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"524fcd19164cb488498f7d519e9cf81962337bf882d3bd89f19458a7602ada74","body_hash":"c040586efb633d96869a3c368e790ed2469586f002a70ba202955061f1434787","strict":true,"agent_id":"claude","engine_versions":{"claude":"2.1.216"}} +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"f533867efd5788999166c7b15796355d230f006f05766f9763b10e774c9d7f5a","body_hash":"88153879940847d9708a7178b916957cdc184bf622c02b48046e9a8b77aba38b","strict":true,"agent_id":"claude","engine_versions":{"claude":"2.1.216"}} # gh-aw-manifest: {"version":1,"secrets":["ANTHROPIC_API_KEY","COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GH_AW_OTEL_GRAFANA_AUTHORIZATION","GH_AW_OTEL_GRAFANA_ENDPOINT","GH_AW_OTEL_SENTRY_AUTHORIZATION","GH_AW_OTEL_SENTRY_ENDPOINT","GITHUB_TOKEN"],"actions":[{"repo":"actions/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7.0.0"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.37","digest":"sha256:0d35e8682845f183c1c634699a8e8a6cbe2c271b867031410df74533243c5f67","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.37@sha256:0d35e8682845f183c1c634699a8e8a6cbe2c271b867031410df74533243c5f67"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.37","digest":"sha256:fc2970aadaeae05993e76697d29f03dc8bfb9248ff87a8f3d8b0975485a4b317","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.37@sha256:fc2970aadaeae05993e76697d29f03dc8bfb9248ff87a8f3d8b0975485a4b317"},{"image":"ghcr.io/github/gh-aw-firewall/cli-proxy:0.27.37","digest":"sha256:1d5300d9b08e1c4f2ad1830860656a0656383a83280058f17e805a7c3ecda203","pinned_image":"ghcr.io/github/gh-aw-firewall/cli-proxy:0.27.37@sha256:1d5300d9b08e1c4f2ad1830860656a0656383a83280058f17e805a7c3ecda203"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.37","digest":"sha256:5abc51995e5901c5d1daeefc957301ee409980e2e607391ec22c06cb2513327b","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.37@sha256:5abc51995e5901c5d1daeefc957301ee409980e2e607391ec22c06cb2513327b"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} # This file was automatically generated by gh-aw. DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md # @@ -27,6 +27,7 @@ # # Resolved workflow manifest: # Imports: +# - shared/ai-coding-dictionary.md # - shared/otlp.md # # Secrets used: @@ -269,21 +270,21 @@ jobs: run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_785031b7d30c0f96_EOF' + cat << 'GH_AW_PROMPT_5ec3c3f8359f9e6d_EOF' - GH_AW_PROMPT_785031b7d30c0f96_EOF + GH_AW_PROMPT_5ec3c3f8359f9e6d_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/cache_memory_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_785031b7d30c0f96_EOF' + cat << 'GH_AW_PROMPT_5ec3c3f8359f9e6d_EOF' Tools: create_issue, missing_tool, missing_data, noop - GH_AW_PROMPT_785031b7d30c0f96_EOF + GH_AW_PROMPT_5ec3c3f8359f9e6d_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_785031b7d30c0f96_EOF' + cat << 'GH_AW_PROMPT_5ec3c3f8359f9e6d_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -312,13 +313,14 @@ jobs: {{/if}} - GH_AW_PROMPT_785031b7d30c0f96_EOF + GH_AW_PROMPT_5ec3c3f8359f9e6d_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/cli_proxy_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_785031b7d30c0f96_EOF' + cat << 'GH_AW_PROMPT_5ec3c3f8359f9e6d_EOF' {{#runtime-import .github/workflows/shared/otlp.md}} + {{#runtime-import .github/workflows/shared/ai-coding-dictionary.md}} {{#runtime-import .github/workflows/step-name-alignment.md}} - GH_AW_PROMPT_785031b7d30c0f96_EOF + GH_AW_PROMPT_5ec3c3f8359f9e6d_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 diff --git a/.github/workflows/step-name-alignment.md b/.github/workflows/step-name-alignment.md index 80337f5395c..8037cf77f6b 100644 --- a/.github/workflows/step-name-alignment.md +++ b/.github/workflows/step-name-alignment.md @@ -14,6 +14,7 @@ network: - github imports: - shared/otlp.md +- shared/ai-coding-dictionary.md safe-outputs: create-issue: expires: 2d @@ -86,6 +87,7 @@ Maintain consistent, accurate, and descriptive step names by: 4. Identifying inconsistencies, inaccuracies, or unclear names 5. Creating issues with improvement suggestions when problems are found 6. Using cache memory to track previous suggestions and stay consistent +7. Normalizing AI-coding wording with the shared AI Coding Dictionary reference ## Available Tools @@ -219,6 +221,10 @@ Verify that step names accurately describe what the step does: #### C. Glossary Alignment +When a step name uses generic AI-coding terms, validate wording with both: +- Project glossary (`docs/src/content/docs/reference/glossary.md`) for repository-specific terms +- Shared AI Coding Dictionary reference for canonical generic AI terminology + Ensure technical terminology matches the project glossary: **Check for:** diff --git a/.github/workflows/technical-doc-writer.lock.yml b/.github/workflows/technical-doc-writer.lock.yml index d4fb39cf5e4..2dc2ad68842 100644 --- a/.github/workflows/technical-doc-writer.lock.yml +++ b/.github/workflows/technical-doc-writer.lock.yml @@ -1,4 +1,4 @@ -# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"b3f3dc7b5c5c3733bd80c2decf39d87e7c1d6a953db89f80ed4a70c08907a37a","body_hash":"1fcedf1604a60abf193b377aba84c299c8416c889f021672be3911bb9b214859","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} +# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"f7860abd398fbefad58b92da000d02610002e1acab01ec576f3e255e650703b5","body_hash":"5827c30acee23650909586c5cdbc6937019445e186435e1c7d52e262af2bf71b","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.73"}} # gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_CI_TRIGGER_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GH_AW_OTEL_GRAFANA_AUTHORIZATION","GH_AW_OTEL_GRAFANA_ENDPOINT","GH_AW_OTEL_SENTRY_AUTHORIZATION","GH_AW_OTEL_SENTRY_ENDPOINT","GITHUB_TOKEN"],"actions":[{"repo":"actions/cache/restore","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/cache/save","sha":"55cc8345863c7cc4c66a329aec7e433d2d1c52a9","version":"v6.1.0"},{"repo":"actions/checkout","sha":"9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0","version":"v7.0.0"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.37","digest":"sha256:0d35e8682845f183c1c634699a8e8a6cbe2c271b867031410df74533243c5f67","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.37@sha256:0d35e8682845f183c1c634699a8e8a6cbe2c271b867031410df74533243c5f67"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.37","digest":"sha256:fc2970aadaeae05993e76697d29f03dc8bfb9248ff87a8f3d8b0975485a4b317","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.37@sha256:fc2970aadaeae05993e76697d29f03dc8bfb9248ff87a8f3d8b0975485a4b317"},{"image":"ghcr.io/github/gh-aw-firewall/cli-proxy:0.27.37","digest":"sha256:1d5300d9b08e1c4f2ad1830860656a0656383a83280058f17e805a7c3ecda203","pinned_image":"ghcr.io/github/gh-aw-firewall/cli-proxy:0.27.37@sha256:1d5300d9b08e1c4f2ad1830860656a0656383a83280058f17e805a7c3ecda203"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.37","digest":"sha256:5abc51995e5901c5d1daeefc957301ee409980e2e607391ec22c06cb2513327b","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.37@sha256:5abc51995e5901c5d1daeefc957301ee409980e2e607391ec22c06cb2513327b"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.4.3","digest":"sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.4.3@sha256:3c744710ea275cd5ee65db92a1099e0d980754bd9fafda9ce67704c67004dc83"},{"image":"ghcr.io/github/gh-aw-node","digest":"sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b","pinned_image":"ghcr.io/github/gh-aw-node@sha256:529d02eb970b1161aa25c593a9c3df57fdfad5a8add328cb3b6eccef66f3183b"},{"image":"ghcr.io/github/github-mcp-server:v1.6.0","digest":"sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3","pinned_image":"ghcr.io/github/github-mcp-server:v1.6.0@sha256:2b0c48b070f61e9d3969269ead600f62d00fb237b60ac849ef3d166ee7de9ad3"}]} # This file was automatically generated by gh-aw. DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md # @@ -29,6 +29,7 @@ # Imports: # - ../agents/technical-doc-writer.agent.md # - ../skills/documentation/SKILL.md +# - shared/ai-coding-dictionary.md # - shared/otlp.md # # Secrets used: @@ -274,25 +275,25 @@ jobs: run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_8860904b24d7e968_EOF' + cat << 'GH_AW_PROMPT_202e43eab68b143d_EOF' - GH_AW_PROMPT_8860904b24d7e968_EOF + GH_AW_PROMPT_202e43eab68b143d_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/cache_memory_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/repo_memory_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_8860904b24d7e968_EOF' + cat << 'GH_AW_PROMPT_202e43eab68b143d_EOF' Tools: add_comment, create_pull_request, missing_tool, missing_data, noop - GH_AW_PROMPT_8860904b24d7e968_EOF + GH_AW_PROMPT_202e43eab68b143d_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_create_pull_request.md" - cat << 'GH_AW_PROMPT_8860904b24d7e968_EOF' + cat << 'GH_AW_PROMPT_202e43eab68b143d_EOF' - GH_AW_PROMPT_8860904b24d7e968_EOF + GH_AW_PROMPT_202e43eab68b143d_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/mcp_cli_tools_prompt.md" - cat << 'GH_AW_PROMPT_8860904b24d7e968_EOF' + cat << 'GH_AW_PROMPT_202e43eab68b143d_EOF' The following GitHub context information is available for this workflow: {{#if github.actor}} @@ -321,15 +322,16 @@ jobs: {{/if}} - GH_AW_PROMPT_8860904b24d7e968_EOF + GH_AW_PROMPT_202e43eab68b143d_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/cli_proxy_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_8860904b24d7e968_EOF' + cat << 'GH_AW_PROMPT_202e43eab68b143d_EOF' {{#runtime-import .github/skills/documentation/SKILL.md}} {{#runtime-import .github/agents/technical-doc-writer.agent.md}} + {{#runtime-import .github/workflows/shared/ai-coding-dictionary.md}} {{#runtime-import .github/workflows/shared/otlp.md}} {{#runtime-import .github/workflows/technical-doc-writer.md}} - GH_AW_PROMPT_8860904b24d7e968_EOF + GH_AW_PROMPT_202e43eab68b143d_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 diff --git a/.github/workflows/technical-doc-writer.md b/.github/workflows/technical-doc-writer.md index 34d97b10644..439890ecd9d 100644 --- a/.github/workflows/technical-doc-writer.md +++ b/.github/workflows/technical-doc-writer.md @@ -28,6 +28,7 @@ network: imports: - ../skills/documentation/SKILL.md - ../agents/technical-doc-writer.agent.md + - shared/ai-coding-dictionary.md - shared/otlp.md safe-outputs: @@ -128,6 +129,7 @@ When reviewing documentation for the specified topic in the **docs/** folder: 3. **Make improvements** to the documentation as needed: - Fix clarity and conciseness issues - Improve tone and voice consistency with GitHub Docs + - Normalize AI-coding terminology using the shared AI Coding Dictionary reference - Enhance code block formatting and examples - Improve structure and organization - Add missing prerequisites or setup steps