-
Notifications
You must be signed in to change notification settings - Fork 2
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
Conversation
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
There was a problem hiding this 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/)
docs/guides/using-guardrails/ai/enable-intelligent-assessment/index.md
Outdated
Show resolved
Hide resolved
docs/guides/using-guardrails/ai/enable-policy-pack-summary/index.md
Outdated
Show resolved
Hide resolved
docs/guides/using-guardrails/ai/enable-intelligent-fixes/index.md
Outdated
Show resolved
Hide resolved
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: abhiturbot Preview Link: turbot-com-git-docs-guardrailsadd-ai-assessment-guide-turbot.vercel.app |
…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]>
…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]>
Validating guide: /guardrails-docs/docs/guides/using-guardrails/enable-intelligent-assessment/index.md
Overview Validator Prompt:
Overview Section [PASS]
## Prerequisites
Prerequisites Validator Prompt:
Prerequisites Section [PASS]
## Prerequisites
section presentSteps Validator Prompt:
Here is the validation of the steps section for the provided markdown file:
Steps Section [PASS]
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]
## Troubleshooting
section presentThe 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]