Skip to content

[docs] Update documentation for features from 2025-10-19#1970

Merged
pelikhan merged 1 commit intomainfrom
docs/update-2025-10-19-0077fd7fcc489172
Oct 19, 2025
Merged

[docs] Update documentation for features from 2025-10-19#1970
pelikhan merged 1 commit intomainfrom
docs/update-2025-10-19-0077fd7fcc489172

Conversation

@dsyme
Copy link
Copy Markdown
Collaborator

@dsyme dsyme commented Oct 19, 2025

Documentation Updates - 2025-10-19

This PR updates the documentation based on features merged in the last 24 hours.

Features Documented

1. Services Support in Imports (from #1945)

  • File: docs/src/content/docs/reference/imports.md
  • Changes:
    • Updated frontmatter merging section to include services: field
    • Added example demonstrating services merging with Jupyter MCP server
    • Shows how Docker services can be imported alongside MCP servers

2. New Shared MCP Workflows (from #1949, #1945)

  • File: docs/src/content/docs/guides/mcps.md
  • Changes:
    • Added "Available Shared MCP Configurations" section
    • Documented Jupyter notebook integration (execute cells, manage notebooks)
    • Documented Drain3 log analysis (8 tools for log pattern mining)
    • Listed other available shared MCP servers
    • Added mcp-debug workflow mention in troubleshooting section

3. Custom Safe-Output Example (from #1963)

  • File: docs/src/content/docs/guides/custom-safe-outputs.md
  • Changes:
    • Added "Example: MCP Diagnostic Reporting" section
    • Documented report_diagnostics_to_pull_request safe-job
    • Provided usage example for posting diagnostic findings to PRs
    • Added Related Documentation section

Merged PRs Referenced

Documentation Guidelines

All changes follow the documentation instructions in .github/instructions/documentation.instructions.md:

  • Used neutral, technical tone
  • Followed Diátaxis framework (Reference and How-to Guide categories)
  • Used proper markdown headings (not bold text)
  • Used aw language tag for agentic workflow code samples
  • Kept components minimal, preferring standard markdown

Notes

The features are already well-documented inline in their respective shared workflow files (.github/workflows/shared/mcp/drain3.md, .github/workflows/shared/mcp/jupyter.md, .github/workflows/shared/mcp-debug.md). This PR adds user-facing documentation in the main docs site to help users discover and understand these features.

AI generated by Daily Documentation Updater

Update documentation to reflect new features merged in the last 24 hours.

Changes made:
- Updated reference/imports.md to document services support in imports
- Added example of services merging with Jupyter MCP server
- Updated guides/mcps.md to document new shared MCP workflows (drain3, jupyter)
- Added debugging section mentioning mcp-debug shared workflow
- Updated guides/custom-safe-outputs.md with report_diagnostics_to_pull_request example
- Added MCP Diagnostic Reporting section demonstrating custom safe-output pattern

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@dsyme dsyme added automation documentation Improvements or additions to documentation labels Oct 19, 2025
@pelikhan pelikhan merged commit 78a88f0 into main Oct 19, 2025
27 checks passed
@pelikhan pelikhan deleted the docs/update-2025-10-19-0077fd7fcc489172 branch October 19, 2025 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants