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.
This commit is contained in:
@@ -1,8 +1,9 @@
|
||||
# ♻️ LifecycleStack
|
||||
|
||||
## Overview
|
||||
LifecycleStack will eventually house the tooling and processes that manage the evolution of TSYSDevStack workloads—from ideation and delivery to ongoing operations. While the folder is in its inception phase, this README captures the intent and provides collaboration hooks for the future.
|
||||
|
||||
---
|
||||
|
||||
## Focus Areas
|
||||
| Stream | Description | Status |
|
||||
|--------|-------------|--------|
|
||||
@@ -10,10 +11,33 @@ LifecycleStack will eventually house the tooling and processes that manage the e
|
||||
| Observability Loop | Capture learnings from SupportStack deployments back into build workflows. | 🛠️ Planning |
|
||||
| Governance & Quality | Codify checklists, runbooks, and lifecycle metrics. | 🛠️ Planning |
|
||||
|
||||
## Collaboration Guidelines
|
||||
- Start proposals under `collab/` (create the directory when needed) to keep ideation separate from implementation.
|
||||
- Reference upstream stack READMEs (Cloudron, Support, Toolbox) when describing dependencies or hand-offs.
|
||||
- Keep diagrams and decision records in Markdown so they are versionable alongside code.
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
1. Navigate to the LifecycleStack directory:
|
||||
```bash
|
||||
cd LifecycleStack
|
||||
```
|
||||
|
||||
2. Review the `collab/` directory for planning documents and collaboration notes:
|
||||
```bash
|
||||
ls -la collab/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧭 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 **LifecycleBot**, an AI agent focused on LifecycleStack workflows.
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
1. Draft an initial lifecycle charter outlining environments and promotion triggers.
|
||||
@@ -21,3 +45,8 @@ LifecycleStack will eventually house the tooling and processes that manage the e
|
||||
3. Incorporate ToolboxStack routines for reproducible release tooling.
|
||||
|
||||
> 📝 _Tip: If you are beginning new work here, open an issue or doc sketch that points back to this roadmap so the broader team can coordinate._
|
||||
|
||||
---
|
||||
|
||||
## 📄 License
|
||||
See [LICENSE](../LICENSE) for full terms. Contributions are welcome—open a discussion in the relevant stack's `collab/` area to kick things off.
|
||||
|
||||
Reference in New Issue
Block a user