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.6 KiB

Raw Permalink Blame History

🧰 ToolboxStack

ToolboxStack provides reproducible developer workspaces for TSYSDevStack contributors. The current toolbox-base image captures the daily-driver container environment used across the project.

Area	Description	Path
Dev Container Image	Ubuntu 24.04 base with shell tooling, mise, aqua-managed CLIs, and Docker socket access.	`output/toolbox-base/Dockerfile`
Build Helpers	Wrapper scripts for building (`build.sh`) and running (`run.sh`) the Compose service.	`output/toolbox-base/`
Devcontainer Config	VS Code Remote Container definition referencing the Compose service.	`output/toolbox-base/.devcontainer/devcontainer.json`
Prompt & Docs	Onboarding prompt plus a feature-rich README for future collaborators.	`output/toolbox-base/PROMPT`, `output/toolbox-base/README.md`
Collaboration Notes	Shared design prompts and coordination notes for toolbox evolution.	`collab/`

Quick Start

cd output/toolbox-base
./build.sh        # build the image with UID/GID matching your host
./run.sh up       # launch the toolbox-base service in the background
docker exec -it tsysdevstack-toolboxstack-toolbox-base zsh

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.

🧭 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 for full terms. Contributions are welcome—open a discussion in the relevant stack's collab/ area to kick things off.

2.6 KiB Raw Permalink Blame History