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:
@@ -29,4 +29,22 @@ Use `./run.sh down` to stop the container when you are finished.
|
||||
## Contribution Tips
|
||||
- Document every tooling change in both the `PROMPT` and `README.md`.
|
||||
- Prefer installing CLIs via `aqua` and language runtimes via `mise` to keep the environment reproducible.
|
||||
- Keep cache directories (`.build-cache/`, mise mounts) out of Git—they are already covered by the repo’s `.gitignore`.
|
||||
- Keep cache directories (`.build-cache/`, mise mounts) out of Git—they are already covered by the repo's `.gitignore`.
|
||||
|
||||
---
|
||||
|
||||
## 🧭 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 **ToolboxBot**, an AI agent focused on ToolboxStack workspace management.
|
||||
|
||||
---
|
||||
|
||||
## 📄 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