docs: add stack readmes and overview
This commit is contained in:
32
ToolboxStack/README.md
Normal file
32
ToolboxStack/README.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# 🧰 ToolboxStack
|
||||
|
||||
ToolboxStack provides reproducible developer workspaces for TSYSDevStack contributors. The current `toolbox-base` image captures the daily-driver container environment used across the project.
|
||||
|
||||
---
|
||||
|
||||
## Contents
|
||||
| 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`](output/toolbox-base/Dockerfile) |
|
||||
| Build Helpers | Wrapper scripts for building (`build.sh`) and running (`run.sh`) the Compose service. | [`output/toolbox-base/`](output/toolbox-base) |
|
||||
| Devcontainer Config | VS Code Remote Container definition referencing the Compose service. | [`output/toolbox-base/.devcontainer/devcontainer.json`](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/PROMPT), [`output/toolbox-base/README.md`](output/toolbox-base/README.md) |
|
||||
| Collaboration Notes | Shared design prompts and coordination notes for toolbox evolution. | [`collab/`](collab) |
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
```bash
|
||||
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`.
|
||||
Reference in New Issue
Block a user