ReachableCEO
b53c0f5a05
- 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.
60 lines
2.6 KiB
Markdown
60 lines
2.6 KiB
Markdown
# 🌐 TSYSDevStack
|
||
|
||
> A constellation of curated stacks that power rapid prototyping, support simulations, developer workspaces, and (soon) lifecycle orchestration for TSYS Group.
|
||
|
||
---
|
||
|
||
## 📚 Stack Directory Map
|
||
| Stack | Focus | Highlights |
|
||
|-------|-------|------------|
|
||
| [🛰️ CloudronStack](CloudronStack/README.md) | Cloudron application packaging and upstream research. | Catalog of third-party services grouped by capability. |
|
||
| [♻️ LifecycleStack](LifecycleStack/README.md) | Promotion workflows, governance, and feedback loops. | Roadmap placeholders ready for lifecycle charters. |
|
||
| [🛟 SupportStack](SupportStack/README.md) | Demo environment for support tooling (homepage, WakaAPI, MailHog, socket proxy). | Control script automation, Docker Compose bundles, targeted shell tests. |
|
||
| [🧰 ToolboxStack](ToolboxStack/README.md) | Reproducible developer workspaces and containerized tooling. | Ubuntu-based dev container with mise, aqua, and helper scripts. |
|
||
|
||
---
|
||
|
||
## 🚀 Quick Start
|
||
1. **Clone & Inspect**
|
||
```bash
|
||
git clone <repo-url>
|
||
cd TSYSDevStack
|
||
tree -L 2 # optional: explore the stack layout
|
||
```
|
||
2. **Run the Support Stack Demo**
|
||
```bash
|
||
cd SupportStack
|
||
./output/code/TSYSDevStack-SupportStack-Demo-Control.sh start
|
||
./output/code/TSYSDevStack-SupportStack-Demo-Control.sh test
|
||
```
|
||
> Uses Docker Compose bundles under `SupportStack/output/docker-compose/`.
|
||
3. **Enter the Toolbox Workspace**
|
||
```bash
|
||
cd ToolboxStack/output/toolbox-base
|
||
./build.sh && ./run.sh up
|
||
docker exec -it tsysdevstack-toolboxstack-toolbox-base zsh
|
||
```
|
||
|
||
---
|
||
|
||
## 🤖 AI Collaboration
|
||
This project uses Qwen AI agents for development and maintenance:
|
||
- **Topside**: Manages top-level README.md and directory structure
|
||
- **CloudronBot**: Handles CloudronStack documentation and packaging
|
||
- **LifecycleBot**: Manages LifecycleStack workflows
|
||
- **SupportBot**: Maintains SupportStack operations
|
||
- **ToolboxBot**: Handles ToolboxStack workspace management
|
||
|
||
---
|
||
|
||
## 🧭 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.
|
||
|
||
---
|
||
|
||
## 📄 License
|
||
See [LICENSE](LICENSE) for full terms. Contributions are welcome—open a discussion in the relevant stack’s `collab/` area to kick things off.
|