Lw11 #394
Open
Lw11 #394
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added workflow screenshots to Explore page showing: - Compliance audit preparation (Benchmark > Objective > Account) - Account security review (Account > Category > Objective) - Priority-driven remediation (Priority > Category > Objective) - Layer coverage analysis (Layer > Objective) Added report screenshots to Reports page showing: - AWS Region Boundary report - AWS Service Boundary report - Guardrails AWS Region Boundary Exceptions report Enhanced Explore page with drag-and-drop grouping description and simplified content for better readability. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- Converted all prevention documentation to conversational, user-focused tone - Removed "Page Layout" sections with exhaustive UI cataloging - Converted bulleted workflows to narrative paragraphs - Added "why it matters" context and real-world scenarios - Fixed all Next Steps hyperlinks to use correct absolute paths - Changed relative paths (./file.md, ../folder/index.md) to absolute paths (/guardrails/docs/prevention/...) Revised 24 files across prevention documentation: - Main sections: index, dashboard, accounts, objectives, preventions, recommendations, simulator - All subsections and detail pages 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Preview Available 🚀Commit Author: Bob Tordella Convert JSX-style inline styles to standard HTML CSS format for proper rendering:
Updated files:
🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com Preview Link: turbot-com-git-docs-guardrailslw11-turbot.vercel.app |
Preview Available 🚀Commit Author: Bob Tordella Convert JSX-style inline styles to standard HTML CSS format for proper rendering:
Updated files:
🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com Preview Link: turbot-com-git-docs-guardrailslw11-turbot.vercel.app |
Preview Available 🚀Commit Author: Bob Tordella Convert JSX-style inline styles to standard HTML CSS format for proper rendering:
Updated files:
🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com Preview Link: turbot-com-git-docs-guardrailslw11-turbot.vercel.app |
- Restructured all prevention documentation pages into individual folders with index.md - Each page now has its own folder containing markdown and associated images - Updated all image references to use relative paths (./image.png) - Changed all image tags from HTML <img> to markdown syntax  Documentation improvements: - Added screenshots to Objectives/Priorities, Categories showing view layouts - Added screenshots to Preventions/Examples, Types, and Layers views - Documented Recommendations detail view with specific EBS volumes example - Added complete workflow for testing SCP recommendations in Simulator - Enhanced Simulator documentation with 6 new screenshots showing all major features Structural changes: - Moved Recommendations under Objectives in sidebar hierarchy - Reordered detail pages to appear after their list pages - Updated sidebar.json to reflect new folder structure - Created LLM-optimized style guide (prompts/style-llm.md) - Created prevention-specific documentation prompt (prompts/prevention.md) All documentation now follows consistent structure: - Markdown files use relative image paths - Links use absolute paths starting with /guardrails - No .md extensions or index.md in links - Each sub-page has dedicated folder with images 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Replaced static prompt files with structured documentation skill following best practices from danielmiessler.com/blog/when-to-use-skills-vs-commands-vs-agents.
New structure:
.claude/skills/docs/
├── skill.md (main routing logic with intent detection)
├── context/
│ ├── style.md (migrated from prompts/style-llm.md)
│ └── prevention.md (migrated from prompts/prevention.md)
└── workflows/
├── new-page.md (create new documentation pages)
├── add-screenshots.md (add/update screenshots workflow)
├── fix-links.md (fix link formatting issues)
└── review.md (review for style compliance)
Benefits over previous prompt system:
- Automatic intent detection and routing
- Modular, reusable workflow commands
- Context files referenced by all workflows
- Better discoverability and organization
- Self-contained domain for documentation tasks
Workflows provide step-by-step guidance for common tasks:
- Creating new pages with proper structure and validation
- Adding screenshots with correct sizing and placement
- Fixing link formatting (absolute paths, no extensions)
- Reviewing docs against comprehensive checklist
The main skill detects user intent and routes to appropriate workflow:
- "Write new page" → new-page workflow
- "Add screenshots" → add-screenshots workflow
- "Fix links" → fix-links workflow
- "Review docs" → review workflow
- General questions → answered using context files
Kept prompts/ directory with README explaining migration for reference during transition period.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
All prompt files have been migrated to .claude/skills/docs/ structure: - prompts/style-llm.md → .claude/skills/docs/context/style.md - prompts/prevention.md → .claude/skills/docs/context/prevention.md The skill system is now the source of truth for documentation guidance. Removed prompts/ directory to avoid duplication and maintenance burden. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Reorganized prevention documentation structure to ensure every section has a tab subpage and merged detail pages into their parent pages. Changes: - Added Accounts tab page (accounts/accounts/index.md) with full account list documentation - Merged account-detail content into accounts tab page as Account Detail View section - Merged objective-detail content into objectives tab page - Merged benchmark-detail content into benchmarks tab page - Merged prevention-detail content into preventions tab page - Updated sidebar.json to: - Add accounts/accounts as first item under Accounts - Remove objective-detail and benchmark-detail references - Remove prevention/detail reference - Deleted standalone detail folders and files Structure now consistent across all sections: - Each section (Accounts, Objectives, Preventions) has its own overview page - Each tab within a section has its own subpage - Detail views are documented as sections within tab pages showing what you see when clicking into an item - No separate detail pages - all detail content inline with tab documentation Benefits: - Clearer navigation - users see tab documentation first - Reduced duplication - detail content contextualizes the list view - Consistent structure across all prevention sections - Better information architecture - detail views explained where they are accessed 🤖 Generated with Claude Code https://claude.com/claude-code Co-Authored-By: Claude <noreply@anthropic.com>
Preview Available 🚀Commit Author: Bob Tordella Convert JSX-style inline styles to standard HTML CSS format for proper rendering:
Updated files:
🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com Preview Link: turbot-com-git-docs-guardrailslw11-turbot.vercel.app |
- Change self-closing object tag to proper open/close tags to fix MDX parsing - Wrap object in centered flex container to prevent TOC layout shift - Use responsive width with max-width constraint instead of percentage
Preview Available 🚀Commit Author: Bob Tordella Convert JSX-style inline styles to standard HTML CSS format for proper rendering:
Updated files:
🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com Preview Link: turbot-com-git-docs-guardrailslw11-turbot.vercel.app |
Major changes: - Consolidated scoring details into single authoritative section with links from all pages - Consolidated categories, priorities, layers, and types with links to detail pages - Restructured accounts section with overview and detailed subsections - Updated all pages to link from first term use instead of "For more information" pattern - Removed Examples tab references (examples now integrated into recommendations) - Updated dashboard/explore and dashboard/reports pages for clarity - Fixed all broken detail page links to use section anchors - Changed "approved/denied" to "allowed/denied" terminology in reports - Made Prevention Scores an H2 section for better hierarchy - Added links for all Key Concepts (objectives, preventions, benchmarks, recommendations) - Captured and added account detail and prevention detail screenshots 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Preview Available 🚀Commit Author: Bob Tordella Convert JSX-style inline styles to standard HTML CSS format for proper rendering:
Updated files:
🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com Preview Link: turbot-com-git-docs-guardrailslw11-turbot.vercel.app |
… format
This commit completes the comprehensive standardization of prevention documentation:
- Converted all variant section titles ("Common Tasks", "Using X to...", "Common Patterns", "Use Cases") to consistent "Common Use Cases" heading
- Reformatted all use case sections to use bullets with bold scenario names followed by explanations
- Improved scannability and consistency across all prevention documentation pages
Files updated:
- objectives/objectives: "Common Tasks" → "Common Use Cases" with bullets
- preventions/preventions: "Common Tasks" → "Common Use Cases" with bullets
- objectives/priorities: "Using Priorities to Plan Work" → "Common Use Cases" with bullets
- objectives/categories: "Using Categories to Assess Balance" → "Common Use Cases" with bullets
- objectives/benchmarks: "Using Benchmarks for Compliance" → "Common Use Cases" with bullets
- preventions/layers: "Common Patterns" → "Common Use Cases" with bullets
- accounts/visualize: Consolidated "Using the Visualization" and "Use Cases" into "Common Use Cases" with bullets
- dashboard/reports: Enhanced existing bullets with expanded explanations
- accounts/accounts: Converted paragraphs to bullet format
- accounts/folders: Converted paragraphs to bullet format
- simulator: Converted paragraphs to bullet format
- objectives/recommendations: Converted paragraphs to bullet format
This standardization improves user experience by providing consistent formatting across all documentation pages, making it easier for users to quickly scan and find relevant use cases for their specific needs.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
… docs Changed all generic uses of "control(s)" to "prevention(s)" or "preventive mechanism(s)" to avoid confusion with Guardrails Controls (the specific runtime resources that enforce policies, as defined in /docs/concepts/controls). Key changes: - "active security controls" → "active preventions" - "foundational controls" → "foundational preventions" - "technical controls" → "preventive mechanisms" - "Build/Access/Config/Runtime layer controls" → "Build/Access/Config/Runtime layer preventions" Preserved terminology where appropriate: - "Service Control Policy" - official AWS term - "UI controls" - navigation elements (zoom controls, etc.) - "Guardrails control(s)" - specific references to Guardrails Controls product feature - "control" as a verb (e.g., "control how network traffic flows") This change improves clarity by distinguishing between: - **Preventions**: The mechanisms documented in this section (SCPs, Azure Policies, account settings, etc.) - **Guardrails Controls**: Runtime enforcement resources with states (OK, Alarm, Error, etc.) Files updated: - prevention/index.md - prevention/objectives/index.md - prevention/objectives/categories/index.md - prevention/preventions/index.md - prevention/preventions/preventions/index.md - prevention/preventions/layers/index.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Created new skills and commands based on this session's documentation work: New Skills: 1. check-terminology.md - Analyzes documentation for terminology conflicts and proposes alternatives 2. batch-edit.md - Systematic approach for multi-file text replacements with planning, execution, and verification phases 3. doc-review.md - Pre-commit checklist covering terminology, structure, content quality, technical accuracy, formatting, and git hygiene New Commands: 1. standardize-sections.md - Identifies inconsistent section titles across docs and proposes standardization CLAUDE.md Enhancements: 1. Prevention Documentation Terminology - Documents the prevention vs control terminology distinction 2. Multi-Step Task Management - Best practices for using TodoWrite with multi-file changes 3. Common Documentation Patterns - Codifies parent-child page structure, Common Use Cases format, and detail page structure These additions capture the patterns and best practices discovered during the prevention documentation restructuring and terminology standardization work, making them reusable for future documentation tasks. 🤖 Generated with Claude Code (https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
…ganization - Update layer weights to correct values (Access 0.95, Config 0.85, Runtime 0.75, Build 0.55) and remove Network layer - Update priority weights to match code implementation (P1=8, P2=5, P3=3, P4=2, P5=1) with accurate descriptions - Add three-level calculation pattern documentation (atomic, within-account, cross-account) - Remove incorrect statements about priority being based on framework prevalence or prerequisites - Remove priority-specific claims from category documentation (any category can have any priority) - Consolidate redundant node type descriptions in visualize documentation - Add navigation links to account detail page sections (Overall Maturity, Benchmarks, Recommendations, Categories, Layers) - Remove specific EBS encryption recommendation examples and policy JSON (already shown in images) - Reorganize recommendations page to separate list view from detail view documentation - Move "Understanding Preventions" before "Available Views" for better context flow - Replace "types" with "prevention types" throughout to avoid confusion with other system types - Replace prescriptive guidance with "Prevention in Depth" section focused on defense-in-depth strategy - Remove "Understanding Scope" section from preventions list (scope not displayed in that view) - Remove general statements about typical Runtime coverage patterns - Remove specific layer weight values from layers page (link to scoring section instead) - Fix incorrect API call reference (MakeBucketPublic -> public bucket policies) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Preview Available 🚀Commit Author: Bob Tordella Convert JSX-style inline styles to standard HTML CSS format for proper rendering:
Updated files:
🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com Preview Link: turbot-com-git-docs-guardrailslw11-turbot.vercel.app |
Updated screenshots to remove obsolete UI elements and show better examples: - Replaced screenshots showing removed "New Benchmark" button and "Examples" tab - Added screenshots with actual data (accounts with preventions, expanded benchmark sections) - Replaced images showing incorrect search/filter behavior Improved documentation accuracy: - Fixed search behavior description (press Enter, not real-time filtering) - Added "Show FullAWSAccess" toggle documentation for visualize filter - Removed all references to custom benchmarks (feature removed) - Added screenshot and text showing combined search + filter usage Restructured prevention types documentation: - Replaced generic categories (SCPs, Azure Policies) with specific prevention types - Organized 12 specific types by layer (Build, Access, Config, Runtime) - Added note that available types depend on installed Turbot mods - Updated examples to use specific type names (AWS SCP Deny Statement, etc.) Enhanced benchmark detail view documentation: - Added screenshot showing expanded/collapsed sections - Added detailed text about interactive expand/collapse functionality - Explained section scores and objective card contents 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Preview Available 🚀Commit Author: Bob Tordella Convert JSX-style inline styles to standard HTML CSS format for proper rendering:
Updated files:
🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com Preview Link: turbot-com-git-docs-guardrailslw11-turbot.vercel.app |
…d screenshots - Reorganize structure: move Understanding SCP Behavior section earlier for better context - Expand How to Use the Simulator with four-section summary and anchor links - Remove scp-details-expanded.png reference - Add comprehensive Adding Events section with H5 subsections: - Adding Events from a File - Adding Mock Events (with template selection flow) - Adding Events Manually - Separate Evaluation Results as major section with Viewing Denied Actions subsection - Add 7 new screenshots showing event creation workflow: - add-event-dialog.png - Initial dialog with tabs - add-event-mock.png - Mock events service categories - add-event-mock-expanded.png - Expanded category with templates - add-event-mock-selected.png - Selected template with populated fields - add-event-manual.png - Manual entry fields - cloudtrail-events-panel.png - Events list - simulator-denied-1600.png - Visual denial feedback (1600px for full diagram) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Preview Available 🚀Commit Author: Bob Tordella Convert JSX-style inline styles to standard HTML CSS format for proper rendering:
Updated files:
🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com Preview Link: turbot-com-git-docs-guardrailslw11-turbot.vercel.app |
…eatures Add two new patterns to Common Documentation Patterns section: - Organizing Documentation by UI Flow: Document features in the order users encounter them in the interface to reduce cognitive load - Interactive Feature Documentation: Three-part screenshot approach (overview, interaction, results) for documenting dialogs, forms, and wizards These patterns were identified while enhancing the simulator documentation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Conducted thorough 6-phase review of all prevention documentation covering structure, content validation, spelling/grammar, formatting, quality, and domain-specific guidelines. Documentation found to be in excellent condition with only minor fixes needed. Changes made: - Remove 10 unused images (resolution variants, deprecated screenshots, old naming conventions) - Fix 6 broken recommendations links (corrected path from /prevention/recommendations to /prevention/objectives/recommendations) - Remove 2 links to deprecated examples page feature - Add comprehensive documentation review skill for future use Results: - 100% image utilization (48/48 images referenced) - 100% valid internal links (108 links verified) - Zero spelling or grammar errors across 20 files - Perfect style guide compliance - Documentation health score: A+ (98/100) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Preview Available 🚀Commit Author: Bob Tordella Convert JSX-style inline styles to standard HTML CSS format for proper rendering:
Updated files:
🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com Preview Link: turbot-com-git-docs-guardrailslw11-turbot.vercel.app |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.