Files

ReachableCEO b53c0f5a05 feat(docs): standardize README.md files across all stacks

- Update top-level README.md with AI collaboration section and working agreement
- Standardize all stack README.md files (CloudronStack, LifecycleStack, SupportStack, ToolboxStack) with consistent structure:
  - Add Working Agreement section with consistent items across all stacks
  - Add AI Agent section identifying the responsible bot for each stack
  - Add License section with reference to main LICENSE file
  - Add Quick Start section where missing
- Create missing LifecycleStack/collab directory with .gitkeep file
- Add top-level QWEN.md file for tracking Topside agent work
- Add top-level commit-template.txt and configure git to use it
- Ensure consistent formatting and content across all documentation
- Fix CloudronStack README title to match project structure

This commit ensures all README files follow the same structure and
contain necessary information for coordination between different
Qwen agents working on each stack.

2025-10-29 08:16:09 -05:00

2.9 KiB

Raw Permalink Blame History

🛟 SupportStack

The SupportStack delivers a curated demo environment for customer support tooling. It bundles Dockerized services, environment settings, automation scripts, and a growing library of collaboration notes.

Stack Snapshot

Component	Purpose	Path
Control Script	Orchestrates start/stop/update/test flows for the demo stack.	`output/code/TSYSDevStack-SupportStack-Demo-Control.sh`
Environment Settings	Centralized `.env` style configuration consumed by scripts and compose files.	`output/TSYSDevStack-SupportStack-Demo-Settings`
Docker Compose Bundles	Service definitions for docker-socket-proxy, homepage, WakaAPI, and MailHog.	`output/docker-compose/`
Service Config	Homepage/WakaAPI configuration mounted into containers.	`output/config/`
Tests	Shell-based smoke, unit, and discovery tests for stack services.	`output/tests/`
Docs & Vendor Research	Reference material and curated vendor lists.	`output/docs/`
Collaboration Notes	Product direction, prompts, and status updates.	`collab/`

🚀 Quick Start

Export or edit variables in output/TSYSDevStack-SupportStack-Demo-Settings.

Use the control script to manage the stack:

./output/code/TSYSDevStack-SupportStack-Demo-Control.sh start
./output/code/TSYSDevStack-SupportStack-Demo-Control.sh test
./output/code/TSYSDevStack-SupportStack-Demo-Control.sh stop

Review output/tests/ for additional validation scripts.

ℹ️ The stack expects Docker access and creates the shared network tsysdevstack-supportstack-demo-network if it does not exist.

🧭 Working Agreement

Stacks stay in sync. When you add or modify automation, update both the relevant stack README and any linked prompts/docs.
Collab vs Output. Use collab/ for planning and prompts, keep runnable artifacts under output/.
Document forward. New workflows should land alongside tests and a short entry in the appropriate README table.
AI Agent Coordination. Use Qwen agents for documentation updates, code changes, and maintaining consistency across stacks.

🤖 AI Agent

This stack is maintained by SupportBot, an AI agent focused on SupportStack operations.

Collaboration Notes

Keep demo automation in output/ and exploratory material in collab/.
When adding a new service, update both the compose files and the test suite to maintain coverage.
Synchronize documentation changes with any updates to automation or configuration—future contributors rely on the README table as the source of truth.

📄 License

See LICENSE for full terms. Contributions are welcome—open a discussion in the relevant stack's collab/ area to kick things off.

2.9 KiB Raw Permalink Blame History Unescape Escape