KNEL/TSYSDevStack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
- 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.
This commit is contained in:
Charles N Wyble - admin
2025-10-29 08:16:09 -05:00
parent 141accf5e6
commit b53c0f5a05
8 changed files with 201 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
SupportStack/README.md
View File

@@ -17,7 +17,7 @@ The SupportStack delivers a curated demo environment for customer support toolin
---
## Getting Started
## 🚀 Quick Start
1. Export or edit variables in `output/TSYSDevStack-SupportStack-Demo-Settings`.
2. Use the control script to manage the stack:
```bash
@@ -31,7 +31,25 @@ The SupportStack delivers a curated demo environment for customer support toolin
---
## 🧭 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](../LICENSE) for full terms. Contributions are welcome—open a discussion in the relevant stack's `collab/` area to kick things off.