Skip to content

Add > Guide > Intelligent Assessment, Intelligent Fixes, Policy Pack Summary and restructure AI section > Draft #352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 42 commits into from
Jun 30, 2025

Conversation

RahulSrivastav14
Copy link
Contributor

@RahulSrivastav14 RahulSrivastav14 commented Jun 23, 2025

Validating guide: /guardrails-docs/docs/guides/using-guardrails/enable-intelligent-assessment/index.md


Overview Validator Prompt:

Overview Section [PASS]
Criteria Pass/Fail/Warning Suggestions
Overview content exists between H1 and ## Prerequisites
Overview starts with "In this guide, you will:"
Uses second person
Contains at least one hyperlink
Overview is a list or paragraph

Prerequisites Validator Prompt:

Prerequisites Section [PASS]
Criteria Pass/Fail/Warning Suggestions
## Prerequisites section present
Section comes after overview
Prerequisites are a bulleted list
Simple items do not end with periods
Sentences/fragments end with periods
Only setup/access items included
Uses second person where appropriate

Steps Validator Prompt:

Here is the validation of the steps section for the provided markdown file:

Steps Section [PASS]
Criteria Pass/Fail/Warning Location Suggestions
At least one step section present - -
Step headers are H2 - -
Step headers are sequential - -
Step header format - -
Step header starts with verb - -
Step content is present - -
Steps are before Review/Next Steps/Troubleshooting - -
No skipped or duplicate step numbers - -
Uses second person where appropriate - -
Images/callouts are allowed - -
Review section is titled exactly '## Review' - The document does not contain a Review section. Consider adding one if appropriate.

The steps section follows the required format and passes all validation criteria except for the missing Review section, which is optional. Great job on the step-by-step instructions!


Troubleshooting Validator Prompt:

Here is the validation of the Troubleshooting section in the provided markdown file:

Troubleshooting Section [PASS]
Criteria Pass/Fail/Warning Suggestions
## Troubleshooting section present
Section is in markdown table format
Last row mentions Further Assistance

The Troubleshooting section passes all the specified criteria. It is present, formatted as a markdown table, and the last row mentions "Further Assistance" as required.


Callout Validator Prompt:

Callout Section [PASS]
Criteria Pass/Fail/Warning Location Suggestions
All callouts use correct format All callouts N/A
Only allowed callout types used All callouts N/A

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

@rajlearner17 rajlearner17 linked an issue Jun 24, 2025 that may be closed by this pull request
@rajlearner17 rajlearner17 changed the title Add > Guide > intelligent Assessment > Draft Add > Guide > Intelligent Assessment > Draft Jun 24, 2025
Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

@rajlearner17 rajlearner17 changed the title Add > Guide > Intelligent Assessment > Draft Add > Guide > Intelligent Assessment, Intelligent Fixes, Policy Pack Summary and restructure AI section > Draft Jun 25, 2025
Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

@rajlearner17 rajlearner17 marked this pull request as ready for review June 25, 2025 09:46
@rajlearner17 rajlearner17 requested a review from Copilot June 27, 2025 17:16
Copy link

@Copilot 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

This PR restructures the AI section by introducing dedicated guides for Intelligent Assessment, Intelligent Fixes, and Policy Pack Summary, and updating navigation to include the new AI features.

  • Add new AI feature guides under docs/guides/using-guardrails/ai/
  • Update sidebar and main index to surface the AI section
  • Rename and adjust the MCP install guide to “Install Guardrails MCP”

Reviewed Changes

Copilot reviewed 10 out of 34 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
docs/sidebar.json Insert placeholder entry for the new AI sidebar
docs/guides/using-guardrails/index.md Replace “AI Tools” link with new “AI” section link and updated description
docs/guides/using-guardrails/ai/install-mcp/index.md Rename frontmatter and heading to “Install Guardrails MCP”
docs/guides/using-guardrails/ai/index.md Add landing page for the AI section
docs/guides/using-guardrails/ai/policy-pack-development/index.md Add guide for Policy Pack Development with AI tools
docs/guides/using-guardrails/ai/ai-sidebar.json Define sidebar items for the AI section
docs/guides/using-guardrails/ai/ai-configuration/index.md Add Turbot AI Configuration guide
docs/guides/using-guardrails/ai/enable-policy-pack-summary/index.md Add guide for enabling Policy Pack Summary
docs/guides/using-guardrails/ai/enable-intelligent-fixes/index.md Add guide for enabling Intelligent Fixes
docs/guides/using-guardrails/ai/enable-intelligent-assessment/index.md Add guide for enabling Intelligent Assessment
Comments suppressed due to low confidence (2)

docs/guides/using-guardrails/ai/ai-configuration/index.md:115

  • [nitpick] Remove trailing slash in the link for consistency with other guides (use /enable-intelligent-fixes).
- [Enable Intelligent Fixes](/guardrails/docs/guides/using-guardrails/ai/enable-intelligent-fixes/)

docs/guides/using-guardrails/ai/ai-configuration/index.md:116

  • [nitpick] Remove trailing slash in the link for consistency with other guides (use /enable-policy-pack-summary).
- [Enable Policy Pack Summary](/guardrails/docs/guides/using-guardrails/ai/enable-policy-pack-summary/)

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

Copy link

Preview Available 🚀

Commit Author: abhiturbot
Commit Message: Add changelog for te v5.51.8

Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app

@rajlearner17 rajlearner17 merged commit 9971ef4 into main Jun 30, 2025
4 checks passed
@rajlearner17 rajlearner17 deleted the add-ai-assessment-guide branch June 30, 2025 13:30
rajlearner17 added a commit that referenced this pull request Jul 1, 2025
…Summary and restructure AI section > Draft (#352)

Co-authored-by: raj <[email protected]>
Co-authored-by: Sumit Popat <[email protected]>
Co-authored-by: David Boeke <[email protected]>
rajlearner17 added a commit that referenced this pull request Jul 2, 2025
…Summary and restructure AI section > Draft (#352)

Co-authored-by: raj <[email protected]>
Co-authored-by: Sumit Popat <[email protected]>
Co-authored-by: David Boeke <[email protected]>
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.

Add guide - Intelligent Fixes Feature Add guide - Add Policy Summary Feature Add guide - Add Intelligent Assessment Feature
4 participants