Skip to content

📝 Update documentation across multiple files#16640

Merged
dsyme merged 7 commits intomainfrom
du
Feb 18, 2026
Merged

📝 Update documentation across multiple files#16640
dsyme merged 7 commits intomainfrom
du

Conversation

@dsyme
Copy link
Contributor

@dsyme dsyme commented Feb 18, 2026

Summary

  • Cleaned up and simplified documentation across various markdown files
  • Removed deprecated warnings and caution blocks
  • Made minor text and formatting improvements

Changes

  • Simplified security and configuration documentation
  • Removed deprecated syntax warnings
  • Adjusted formatting in multiple documentation files
  • Cleaned up text in reference and guide documentation

Copilot AI review requested due to automatic review settings February 18, 2026 20:39
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documentation-only PR that streamlines and modernizes the GH-AW docs by removing deprecated admonitions/warnings and tightening formatting/wording, including updated terminology around the agent sandbox.

Changes:

  • Renamed “Agent Sandbox” references to “Coding Agent Sandbox” across specs/docs/slides.
  • Removed/converted several NOTE/CAUTION/WARNING admonition blocks and deprecated-syntax callouts.
  • Improved markdown formatting (spacing, headings, code block annotations) across multiple reference/guide pages.

Reviewed changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
specs/security-architecture-spec.md Renames the sandbox subsection heading to “Coding Agent Sandbox”.
docs/src/content/docs/reference/triggers.md Removes deprecated trigger syntax note and keeps slash command guidance.
docs/src/content/docs/reference/sandbox.md Renames “Agent Sandbox” to “Coding Agent Sandbox” and simplifies admonitions/sections.
docs/src/content/docs/reference/safe-outputs.md Removes internal/deprecated notes and updates token wording for Copilot reviewer guidance.
docs/src/content/docs/reference/safe-inputs.md Removes “Experimental Feature” caution block from the page intro.
docs/src/content/docs/reference/network.md Simplifies several admonitions and adjusts spacing/layout around tips/sections.
docs/src/content/docs/reference/gh-aw-as-mcp-server.md Rewords/reshapes MCP server documentation; converts many admonitions to plain text sections.
docs/src/content/docs/reference/frontmatter.md Removes several caution blocks and adds spacing tweaks between sections/examples.
docs/src/content/docs/reference/frontmatter-full.md Removes legacy/deprecated schema doc sections (command trigger, legacy sandbox formats, create-agent-task).
docs/src/content/docs/reference/faq.md Streamlines the CI-on-PRs-created-by-token explanation and options list.
docs/src/content/docs/reference/command-triggers.md Removes deprecated syntax and caution blocks; keeps slash_command behavior description.
docs/src/content/docs/patterns/trialops.md Converts production-risk caution into plain text guidance.
docs/src/content/docs/patterns/siderepoops.mdx Changes an admonition type (CAUTION → NOTE) for the local/remote tools constraint.
docs/src/content/docs/guides/upgrading.md Removes breaking-changes caution block from the upgrade steps.
docs/src/content/docs/guides/network-configuration.md Minor wording/formatting changes; removes “use cases” bullets for protocol filtering.
docs/src/content/docs/guides/memoryops.md Changes admonition type (CAUTION → NOTE) for sensitive data warning section.
docs/src/content/docs/guides/github-actions-primer.md Converts an admonition into plain text guidance for workflow placement.
docs/src/content/docs/guides/getting-started-mcp.md Removes deprecated guidance about allowed: vs toolsets: for GitHub tools.
docs/src/content/docs/guides/editing-workflows.md Removes admonition about expression usage/recompilation.
docs/src/content/docs/blog/2026-01-30-imports-and-sharing.md Terminology update: “GitHub Agentic Workflows MCP server” → “GH-AW as an MCP server”.
docs/slides/index.md Slide terminology update: “Agent Sandbox” → “Coding Agent Sandbox”.
Comments suppressed due to low confidence (1)

docs/src/content/docs/reference/frontmatter-full.md:885

  • This schema doc still describes sandbox.agent values srt / Sandbox Runtime as supported, but the compiler only treats AWF/default as supported sandbox types and auto-migrates srt/sandbox-runtime to AWF (see pkg/workflow/sandbox.go:isSupportedSandboxType and migrateSRTToAWF). Please update this section to either (a) document srt as a legacy value that is auto-migrated to awf, or (b) remove srt from the documented options if it’s no longer accepted.
  # Agent sandbox type: 'awf' uses AWF (Agent Workflow Firewall), 'srt' uses
  # Anthropic Sandbox Runtime, or false to disable agent sandbox. Defaults to 'awf'
  # if not specified. Note: Disabling the agent sandbox (false) removes firewall
  # protection but keeps the MCP gateway enabled.
  # (optional)
  # This field supports multiple formats (oneOf):

  # Option 1: Set to false to disable the agent sandbox (firewall). Warning: This
  # removes firewall protection but keeps the MCP gateway enabled. Not allowed in
  # strict mode.
  agent: true

  # Option 2: Sandbox type: 'awf' for Agent Workflow Firewall, 'srt' for Sandbox
  # Runtime
  agent: "awf"

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments