Skip to content

Fix tutorials index formatting inconsistencies#1702

Open
umeshkumar-12r wants to merge 5 commits intomicrosoft:mainfrom
umeshkumar-12r:fix/tutorial-index-formatting
Open

Fix tutorials index formatting inconsistencies#1702
umeshkumar-12r wants to merge 5 commits intomicrosoft:mainfrom
umeshkumar-12r:fix/tutorial-index-formatting

Conversation

@umeshkumar-12r
Copy link
Copy Markdown

@umeshkumar-12r umeshkumar-12r commented May 2, 2026

Summary

Fixes #1629

Fixes formatting inconsistencies in docs/tutorials/index.md to improve readability and maintain a consistent structure across all sections.

Changes

  • Standardized table structure across all sections
  • Fixed spacing inconsistencies in markdown tables
  • Ensured all tutorial entries follow a consistent pattern
  • Cleaned up alignment and removed trailing whitespace
  • Maintained original content and numbering (no functional changes)

Result

The tutorials index page is now consistent, clean, and easier to read.
closes #1629

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 2, 2026

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 github-actions Bot added the size/M Medium PR (< 200 lines) label May 2, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 2, 2026

🤖 AI Agent: docs-sync-checker — Docs Sync

Docs Sync

Documentation is in sync.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 2, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 2, 2026

🤖 AI Agent: code-reviewer — View details

No issues found. Clean change.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 2, 2026

🤖 AI Agent: test-generator — View details

Test coverage looks good. No gaps identified.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 2, 2026

🤖 AI Agent: security-scanner — View details

No security issues found.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 2, 2026

🤖 AI Agent: breaking-change-detector — View details

No breaking changes detected.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 2, 2026

🤖 AI Agent: contributor-guide — View details

Hi @first-time-contributor! 🎉 Thanks for improving the tutorials index formatting—it looks much cleaner and consistent now!

One small issue: please ensure there's a newline at the end of the file to comply with CONTRIBUTING.md. Once that's fixed, this is good to go! 😊

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 2, 2026

PR Review Summary

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

Verdict: ✅ Ready for human review

@imran-siddique imran-siddique enabled auto-merge (squash) May 2, 2026 07:05
@imran-siddique imran-siddique disabled auto-merge May 2, 2026 07:07
@imran-siddique imran-siddique enabled auto-merge (squash) May 2, 2026 07:07
@umeshkumar-12r umeshkumar-12r marked this pull request as draft May 2, 2026 07:21
auto-merge was automatically disabled May 2, 2026 07:21

Pull request was converted to draft

@umeshkumar-12r umeshkumar-12r marked this pull request as ready for review May 2, 2026 07:21
@umeshkumar-12r
Copy link
Copy Markdown
Author

I have resolved the issue based on your review. If there are any mistakes or further changes needed, please guide me .

Copy link
Copy Markdown
Member

@imran-siddique imran-siddique left a comment

Choose a reason for hiding this comment

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

TL;DR: 1 blocker, 2 warnings.

Sev Issue Where
Block Trailing newline removed from file. Add it back. index.md EOF
Warn Several descriptions silently truncated (e.g., 'for MCP servers' dropped, 'spam detection' dropped). A formatting PR should not alter content. index.md multiple rows
Warn Issue #1629 asked for backtick-formatted package names. PR capitalizes them but adds zero backticks. index.md Language Package Guides

Action items: (1) Restore trailing newline. (2) Restore truncated descriptions. (3) Add backticks per issue requirements.

@github-actions github-actions Bot added size/S Small PR (< 50 lines) and removed size/M Medium PR (< 200 lines) labels May 3, 2026
@umeshkumar-12r
Copy link
Copy Markdown
Author

I have resolved the issues based on your review by restoring the trailing newline, restoring the truncated descriptions, and adding backticks as requested. If there are any mistakes or further changes needed, please guide me. Thank you.

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/S Small PR (< 50 lines)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: standardize formatting in tutorials index

2 participants