Skip to content

docs: reorganize sections — Experimental, Design Patterns, Reference restructure#32431

Merged
dsyme merged 5 commits into
mainfrom
docs/reorganize-sections
May 15, 2026
Merged

docs: reorganize sections — Experimental, Design Patterns, Reference restructure#32431
dsyme merged 5 commits into
mainfrom
docs/reorganize-sections

Conversation

@dsyme

@dsyme dsyme commented May 15, 2026

Copy link
Copy Markdown
Collaborator

Restructures the docs sidebar and content directories for clarity.

Changes

Guides

  • Removed "Deterministic Agentic Patterns" → moved to Design Patterns
  • Removed "Ephemerals" → moved to Reference
  • Removed "Audit Reports" → content merged into the Auditing Workflows reference page
  • Renamed "Custom OTLP Attributes" → Telemetry
  • Renamed "Upgrading" → Upgrading Workflows

Design Patterns

  • Added Deterministic Agentic Patterns (from Guides)
  • Renamed "Agentic Ops" → AgenticOps
  • Removed CorrectionOps, TrialOps, Monitoring → moved to Experimental

Reference

  • Added Ephemerals (from Guides)
  • Renamed "Audit" → Auditing Workflows (with audit-with-agents guide content merged in)

New: Experimental section

New experimental/ directory and sidebar section (after Troubleshooting) containing:

  • CorrectionOps (from Design Patterns)
  • TrialOps (from Design Patterns)
  • Monitoring with Projects (from Design Patterns "Monitoring")

Infrastructure

  • Redirects added for all moved/renamed pages
  • All internal cross-links updated across ~20 files

…ture

- Move Deterministic Agentic Patterns from Guides to Design Patterns
- Rename Custom OTLP Attributes guide to Telemetry
- Merge Audit Reports guide into Audit reference page, renamed to Auditing Workflows
- Move Ephemerals from Guides to Reference
- Rename Upgrading sidebar label to Upgrading Workflows
- Add Experimental section (after Troubleshooting) with new experimental/ directory
- Move CorrectionOps, TrialOps, Monitoring to Experimental section
- Rename Monitoring page to Monitoring with Projects
- Rename sidebar label Agentic Ops to AgenticOps
- Add redirects for all moved pages
- Update all internal links across docs
Copilot AI review requested due to automatic review settings May 15, 2026 16:42
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Restructures documentation navigation and page locations for guides, design patterns, reference material, and a new Experimental section.

Changes:

  • Moves/renames docs pages and updates internal links/redirects.
  • Adds Experimental pages for CorrectionOps and TrialOps, and retitles Monitoring with Projects.
  • Merges audit-with-agents content into the audit reference and adds Ephemerals reference content.
Show a summary per file
File Description
docs/src/content/docs/reference/safe-outputs.md Updates monitoring pattern link to Experimental.
docs/src/content/docs/reference/qmd.md Updates telemetry guide link target.
docs/src/content/docs/reference/open-telemetry.md Updates custom telemetry link text/target.
docs/src/content/docs/reference/glossary.md Updates moved Ephemerals, CorrectionOps, and TrialOps links.
docs/src/content/docs/reference/frontmatter.md Updates deterministic/agentic pattern links.
docs/src/content/docs/reference/faq.md Updates TrialOps link.
docs/src/content/docs/reference/ephemerals.md Adds new Ephemerals reference page.
docs/src/content/docs/reference/custom-safe-outputs.md Updates deterministic/agentic pattern link.
docs/src/content/docs/reference/compilation-process.md Updates deterministic/agentic pattern link.
docs/src/content/docs/reference/cache-memory.md Updates Ephemerals cleanup link.
docs/src/content/docs/reference/audit.md Retitles audit reference and merges agent audit workflow guidance.
docs/src/content/docs/patterns/side-repo-ops.mdx Updates TrialOps link.
docs/src/content/docs/patterns/project-ops.mdx Updates monitoring link.
docs/src/content/docs/patterns/orchestration.md Updates monitoring link.
docs/src/content/docs/patterns/expert-ops.md Updates monitoring link.
docs/src/content/docs/patterns/dispatch-ops.md Updates TrialOps links.
docs/src/content/docs/patterns/deterministic-agentic-patterns.md Adds moved deterministic/agentic patterns page.
docs/src/content/docs/patterns/agentic-ops.md Updates related documentation links.
docs/src/content/docs/guides/telemetry.md Retitles telemetry guide and updates related link.
docs/src/content/docs/guides/self-hosted-runners.md Updates Ephemerals maintenance link.
docs/src/content/docs/guides/memoryops.md Updates deterministic patterns link.
docs/src/content/docs/guides/audit-with-agents.md Removes old standalone audit-with-agents guide.
docs/src/content/docs/experimental/trial-ops.md Adds TrialOps page under Experimental.
docs/src/content/docs/experimental/monitoring-with-projects.md Retitles monitoring page.
docs/src/content/docs/experimental/correction-ops.md Adds CorrectionOps page under Experimental.
docs/src/content/docs/examples/project-tracking.md Updates monitoring guide link.
docs/src/content/docs/blog/2026-01-27-operational-patterns.md Updates TrialOps link.
docs/src/content/docs/agent-factory-status.mdx Adds two agent rows to the status table.
docs/astro.config.mjs Updates redirects and sidebar organization.

Copilot's findings

Tip

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

Comments suppressed due to low confidence (1)

docs/src/content/docs/guides/telemetry.md:167

  • The linked page title is Deterministic & Agentic Patterns, but this cross-link omits the ampersand. Updating the visible text keeps the renamed page title consistent across the docs.
  • Files reviewed: 28/33 changed files
  • Comments generated: 9

Comment thread docs/src/content/docs/reference/audit.md
Comment thread docs/astro.config.mjs
Comment thread docs/src/content/docs/reference/qmd.md Outdated
Comment thread docs/src/content/docs/patterns/agentic-ops.md Outdated
Comment thread docs/src/content/docs/reference/safe-outputs.md Outdated
Comment thread docs/src/content/docs/patterns/project-ops.mdx Outdated
Comment thread docs/src/content/docs/examples/project-tracking.md Outdated
Comment thread docs/src/content/docs/patterns/agentic-ops.md Outdated
Comment thread docs/astro.config.mjs
@github-actions

This comment has been minimized.

@dsyme dsyme merged commit 28ef1f2 into main May 15, 2026
32 checks passed
@dsyme dsyme deleted the docs/reorganize-sections branch May 15, 2026 17:00
@github-actions

Copy link
Copy Markdown
Contributor

✅ smoke-ci: safeoutputs CLI comment + comment-memory run (25930442935)

Generated by 🧪 Smoke CI for issue #32431 ·

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.

2 participants