Skip to content

🔧 Clean up and format documentation files#16669

Merged
pelikhan merged 7 commits intomainfrom
du2
Feb 19, 2026
Merged

🔧 Clean up and format documentation files#16669
pelikhan merged 7 commits intomainfrom
du2

Conversation

@dsyme
Copy link
Contributor

@dsyme dsyme commented Feb 18, 2026

Summary

  • Updated markdown formatting in documentation slides and blog files
  • Removed unnecessary navigation links and cleaned up content structure
  • Made minor formatting and link improvements across documentation

Changes

  • Removed some navigation links in blog files
  • Standardized link formatting (using angle brackets)
  • Cleaned up markdown structure in slides and blog content
  • Removed draft blog post and unused sections

Copilot AI review requested due to automatic review settings February 18, 2026 22:51
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

Updates and streamlines documentation content and formatting across references, guides, patterns, examples, slides, and social post planning.

Changes:

  • Standardizes markdown formatting and link presentation across docs and slides.
  • Removes/reshapes several “Best Practices” and other sections, and deletes a draft blog post.
  • Updates documentation around workflow configuration (notably roles) and other reference wording.

Reviewed changes

Copilot reviewed 29 out of 29 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
socials/scripts.sh Removes one scheduled social post entry.
socials/PLAN.md Aligns the written plan with the updated social schedule.
docs/src/content/docs/reference/workflow-structure.md Simplifies “Editing Workflows” guidance wording/formatting.
docs/src/content/docs/reference/threat-detection.md Removes a “Best Practices” section prior to troubleshooting.
docs/src/content/docs/reference/schedule-syntax.md Reworks admonitions/notes and trims best-practices content.
docs/src/content/docs/reference/safe-outputs.md Simplifies assign/unassign-to-user examples and wording.
docs/src/content/docs/reference/memory.md Restructures headings and consolidates troubleshooting/security sections.
docs/src/content/docs/reference/markdown.md Reorganizes sections and trims content; updates scanning section title.
docs/src/content/docs/reference/frontmatter.md Updates frontmatter element list and roles documentation wording/examples.
docs/src/content/docs/reference/frontmatter-full.md Adds roles field to the full frontmatter reference example.
docs/src/content/docs/reference/environment-variables.md Adds spacing/formatting around example sections; trims large sections.
docs/src/content/docs/reference/custom-safe-outputs.md Reorganizes sections and trims “Common Mistakes” content.
docs/src/content/docs/patterns/taskops.md Converts multiple examples into fewer “Example:” sections; trims guidance blocks.
docs/src/content/docs/patterns/specops.md Removes a “Best Practices” section and adjusts spacing.
docs/src/content/docs/patterns/siderepoops.mdx Removes tip and best-practices block content.
docs/src/content/docs/patterns/orchestration.md Simplifies wording and adjusts cross-link formatting.
docs/src/content/docs/patterns/dispatchops.md Updates docs to reference roles: (not on.roles) and trims best-practices sections.
docs/src/content/docs/patterns/dailyops.md Removes a “Best Practices” section.
docs/src/content/docs/guides/serena.md Removes extra blank lines around headings.
docs/src/content/docs/guides/packaging-imports.md Improves readability via spacing around examples/lists.
docs/src/content/docs/guides/memoryops.md Replaces admonition with normal prose/bullets; improves spacing.
docs/src/content/docs/guides/deterministic-agentic-patterns.md Removes a “Best Practices” section.
docs/src/content/docs/examples/project-tracking.md Removes a “Best Practices” section.
docs/src/content/docs/examples/multi-repo/issue-tracking.md Removes a “Best Practices” section.
docs/src/content/docs/examples/multi-repo/feature-sync.md Removes a “Best Practices” section.
docs/src/content/docs/examples/agent-imports.md Renames/rewrites content to emphasize “agent files”; updates examples and constraints.
docs/src/content/docs/blog/2026-02-08-authoring-workflows.md Deletes a draft blog post.
docs/src/content/docs/blog/2026-02-05-how-workflows-work.md Removes “next” navigation and trims “What’s Next?” text.
docs/slides/index.md Improves slide formatting and normalizes link presentation.
Comments suppressed due to low confidence (1)

docs/src/content/docs/examples/agent-imports.md:102

  • The example under “Teams import …” imports two files from .github/agents/ in a single workflow. The custom agents reference states only one agent file can be imported per workflow, so this example appears incorrect. Either reduce to a single agent-file import or clarify that only one .github/agents/* import is allowed and the rest must be non-agent imports.
Teams import agents files based on workflow needs:

```yaml wrap title="Security-focused PR review"
---
on: pull_request
engine: copilot
imports:
  - acme-org/ai-agents/.github/agents/security-auditor.md@v2.0.0
  - acme-org/ai-agents/.github/agents/code-reviewer.md@v1.5.0
---

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Filess

@pelikhan
Copy link
Contributor

Little typo and roles -> on.roles

@pelikhan pelikhan merged commit 3ca20db into main Feb 19, 2026
55 of 56 checks passed
@pelikhan pelikhan deleted the du2 branch February 19, 2026 00:36
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

Comments