Skip to content

docs(tutorials): fix agent-sre tutorial Unicode note and ChaosLibrary API - #2038

Merged
Imran Siddique (imran-siddique) merged 4 commits into
microsoft:mainfrom
SomeshZanwar:docs/fix-agent-sre-tutorial-issues
May 11, 2026
Merged

Imran Siddique (imran-siddique) merged 4 commits into
microsoft:mainfrom
SomeshZanwar:docs/fix-agent-sre-tutorial-issues

Conversation

@SomeshZanwar

Copy link
Copy Markdown
Contributor

Fixes two issues found while running the Agent SRE tutorial end-to-end on Windows (reported in #1642).

Issue 1 : Unicode rendering in Windows Command Prompt
Added a note at the top of the tutorial informing Windows users to run chcp 65001 or use a Unicode-capable terminal (Windows Terminal, VS Code) to avoid corrupted character rendering.

Issue 3 : ChaosLibrary.templates does not exist
The tutorial used library.templates which raises AttributeError: 'ChaosLibrary' object has no attribute 'templates'. Did you mean: '_templates'? against agent-sre==3.5.0.

Fixed by replacing with library.list_templates() which is the correct public API.

Type of Change:

Documentation update

Package(s) Affected:

docs / root

Environment tested:

  • OS: Windows 11
  • Python: 3.12.4
  • agent-sre: 3.5.0

Related issue: #1642

Adding portfolio/research project to the Academic / Research section.
Uses agent-os-kernel and agentmesh-platform to combine AGT policy
evaluation with external data quality signals.

Related discussion: microsoft#1795
@github-actions github-actions Bot added the size/XS Extra small PR (< 10 lines) label May 11, 2026
@github-actions

Copy link
Copy Markdown
🤖 AI Agent: security-scanner — View details

No security issues found.

@github-actions

Copy link
Copy Markdown
🤖 AI Agent: test-generator — View details

Test coverage looks good. No gaps identified.

@github-actions

Copy link
Copy Markdown
🤖 AI Agent: docs-sync-checker — Docs Sync

Docs Sync

  • list_templates() in chaos.py -- missing docstring
  • README.md -- section on ChaosLibrary needs update
  • CHANGELOG.md -- missing entry for behavioral change regarding library.templates to library.list_templates()

@github-actions

Copy link
Copy Markdown
🤖 AI Agent: code-reviewer — View details

TL;DR: 0 blockers, 0 warnings. Clean documentation fix.

# Sev Issue Where

No action items required.

@github-actions

Copy link
Copy Markdown
🤖 AI Agent: breaking-change-detector — API Compatibility

API Compatibility

Severity Change Impact
High ChaosLibrary.templates attribute removed or renamed to _templates Code relying on library.templates will raise AttributeError. Users must update their code to use library.list_templates() instead.

@SomeshZanwar

Copy link
Copy Markdown
Contributor Author

The docs-sync-checker flagged three items : list_templates() docstring in chaos.py, a README.md section update, and a CHANGELOG.md entry. Happy to address any of these in this PR if that's preferred, or leave them for a follow-up if the scope should stay limited to the tutorial fix. Let me know how you'd like to proceed.

@github-actions

Copy link
Copy Markdown

Welcome to the Agent Governance Toolkit! Thanks for your first pull request.
Please ensure tests pass, code follows style (ruff check), and you have signed the CLA.
See our Contributing Guide.

@github-actions

Copy link
Copy Markdown

PR Review Summary

Check Status Details
🔍 Code Review ✅ Passed No issues found
🛡️ Security Scan ✅ Passed No issues found
🔄 Breaking Changes ✅ Completed Analysis complete
📝 Docs Sync ✅ Completed Analysis complete
🧪 Test Coverage ✅ Completed Analysis complete

Verdict: ✅ Ready for human review

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 11, 2026
@imran-siddique
Imran Siddique (imran-siddique) merged commit d478695 into microsoft:main May 11, 2026
13 of 14 checks passed
@SomeshZanwar
Somesh Zanwar (SomeshZanwar) deleted the docs/fix-agent-sre-tutorial-issues branch May 11, 2026 19:11
MohammadHaroonAbuomar pushed a commit to MohammadHaroonAbuomar/agt-acs that referenced this pull request Jun 1, 2026
… API (microsoft#2038)

* Add Data Quality-Aware Agent Governance to ADOPTERS.md

Adding portfolio/research project to the Academic / Research section.
Uses agent-os-kernel and agentmesh-platform to combine AGT policy
evaluation with external data quality signals.

Related discussion: microsoft#1795

* docs(tutorials): fix agent-sre tutorial Unicode note and ChaosLibrary API
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/XS Extra small PR (< 10 lines)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants