feat: Update toolbox-base and template with latest Docker configurations and documentation

\n- Updated Dockerfiles in both toolbox-base and toolbox-template
- Modified build scripts and docker-compose configurations
- Added new audit tools and documentation files
- Created new toolbox-DocStack and toolbox-QADocker implementations
- Updated README and maintenance documentation
This commit is contained in:
2025-10-31 12:46:36 -05:00
parent 48530814d5
commit ab57e3a3a1
92 changed files with 4610 additions and 190 deletions

View File

@@ -0,0 +1,87 @@
#!/usr/bin/env bash
# Script to help maintain the README.md file and keep it up to date
# This script provides guidance on how to update the README.md file when changes are made
set -euo pipefail
echo "📖 README.md Maintenance Guide"
echo "==============================="
echo ""
echo "When making changes to the ToolboxStack, please follow these guidelines to keep the README.md up to date:"
echo ""
echo "1. 📝 Update README.md for any new features or tools added:"
echo " - Add new tools to the appropriate sections"
echo " - Update the directory tree if paths change"
echo " - Modify the Quick Start guide if needed"
echo ""
echo "2. 🔄 Keep the work log current in collab/WORKLOG.md:"
echo " - Add detailed entries with timestamps, activities, challenges, solutions, learnings, and feelings"
echo " - Use the format in the existing entries as a template"
echo " - All time logs must be in local system time"
echo ""
echo "3. 📚 Update documentation links when files are moved or renamed:"
echo " - Check all relative links in README.md"
echo " - Update paths in the 'Contents' table"
echo ""
echo "4. 🧪 Keep testing instructions current:"
echo " - Update the Quick Start guide if build process changes"
echo " - Add new testing procedures as needed"
echo ""
echo "5. 📋 Maintain the Working Agreement:"
echo " - Update guidelines when processes change"
echo " - Ensure all team members are aware of changes"
echo ""
echo "6. 🔗 Cross-reference related documents:"
echo " - Link to collab/WORKLOG.md for detailed work history"
echo " - Reference QWEN.md for AI agent context"
echo " - Point to relevant files in collab/ for collaboration"
echo ""
echo "7. 🗃️ Directory Organization:"
echo " - Keep collab/ for human/LLM interaction (documentation, audit reports, design prompts)"
echo " - Keep output/ for LLM workspace (automated work, toolboxes, PROMPT files)"
echo " - Ensure proper separation between collaboration and output directories"
echo ""
echo "To update the README.md file:"
echo " 1. Edit /home/localuser/TSYSDevStack/ToolboxStack/README.md directly"
echo " 2. Follow the existing structure and formatting"
echo " 3. Use emojis and tables for better readability"
echo " 4. Keep language clear and concise"
echo " 5. Verify all links are correct"
echo ""
echo "For major changes, consider updating this maintenance guide as well."
# Function to check git status and commit if needed
check_git_status() {
echo ""
echo "🔄 Git Status Check"
echo "==================="
# Change to the ToolboxStack directory
cd /home/localuser/TSYSDevStack/ToolboxStack
# Check if there are any changes
if ! git diff --quiet --ignore-submodules --exit-code; then
echo "Git working tree has uncommitted changes. Committing..."
# Add all changes
git add .
# Create a commit message
TIMESTAMP=$(date +"%Y-%m-%d %H:%M:%S")
COMMIT_MSG="docs(toolboxstack): Update README and documentation at ${TIMESTAMP}"
# Commit the changes
if git commit -m "${COMMIT_MSG}"; then
echo "✅ Successfully committed changes"
else
echo "❌ Failed to commit changes" >&2
return 1
fi
else
echo "✅ Git working tree is clean. No changes to commit."
fi
}
# Run git status check
check_git_status