Updates the README to accurately reflect the current state of the codebase from the dev branch, documenting all new features while keeping changes minimal and focused.

📋 Changes Made

✨ New Features Documented

Advanced Logging & Security

• Added comprehensive section for @wgtechlabs/log-engine v2.2.0 features
• Documented PII redaction, structured logging, SBOM generation, and build provenance
• Added environment variables for debugging (LOG_LEVEL=debug, VERBOSE_LOGGING=true)

Commands Documentation

• Added missing admin commands: /activate, /setup, /templates
• Added state management commands: /cancel, /reset
• Organized commands into User and Admin categories for clarity

Environment Configuration

• Noted seamless .env setup across local, Docker, and production environments
• Added debug logging configuration options
• Highlighted Docker service naming conventions

Troubleshooting Section

• Comprehensive troubleshooting guide covering:
  • Bot not responding issues
  • Database connection problems
  • Webhook/Redis connectivity issues
  • Admin access configuration
  • Debug mode activation

Contributing Guidelines

• Made dev branch requirement explicit and mandatory
• Added build/type check requirements
• Clarified code quality standards

🛡️ Supply Chain Security

Documented security features:

# Generate SBOM locally
yarn sbom:generate

# Docker build with SBOM and provenance
yarn docker:build:sbom

🔧 Debug Configuration

Added debugging environment variables:

# Enable debug logging
LOG_LEVEL=debug

# Enable verbose logging for detailed troubleshooting
VERBOSE_LOGGING=true

✅ Validation

• All documented commands verified to exist in codebase
• Package.json scripts confirmed (sbom:generate, docker:build:sbom)
• Code builds successfully and passes type checks
• Environment variables match actual implementation
• Changes are minimal and focused only on missing/new features

🎯 Impact

This update ensures the README accurately represents the current capabilities of the bot, making it easier for users to:

• Understand all available features and commands
• Configure debugging and logging properly
• Troubleshoot common issues independently
• Contribute following the correct development workflow
• Leverage advanced security features like SBOM generation

The documentation now properly reflects the enterprise-grade logging capabilities and supply chain security measures implemented in the dev branch.

This pull request was created as a result of the following prompt from Copilot chat.

Update the README against the current version of the codebase from the dev branch. Ensure all features present in the codebase are covered in the README while keeping the information concise and optimized. Only add or minimally update information if it is missing or outdated—do not make unnecessary changes to existing content.

Key updates to include:

• Document advanced logging and security features powered by @wgtechlabs/log-engine, including PII redaction, SBOM, and provenance options. Briefly mention relevant environment variables for production and debugging.
• List any new commands (user or admin) present in the dev branch that aren’t covered in the README.
• Note that the .env setup is seamless for local, Docker, and production, with service name conventions for Docker.
• Add a troubleshooting snippet (e.g., bot not responding, database/webhook/Redis issues, debug mode).
• Reinforce contributing guidelines (PRs to dev, code must pass build/type checks, etc.) if not already explicit.

Ensure additions are concise and focused on missing or new features. Do not remove or unnecessarily modify existing information.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.