chore(repo): clean root and move docs
- Move docs to docs/; keep areas for prompts only - Relocate Makefile to scripts/Makefile; update docs to use it - Move ci.Dockerfile to docker/ci.Dockerfile; update compose - Move commitlint config to .config and update hook - Remove root AGENTS.md (use area AGENTS.md)
This commit is contained in:
22
README.md
22
README.md
@@ -1,3 +1,23 @@
|
||||
# LLMScaffolding
|
||||
|
||||
TSYS Group LLM Scaffolding. We heavily utilize AI to produce software and other deliverables.
|
||||
Base scaffolding for AI‑assisted work. Clean root; docs in `docs/`; areas for prompts.
|
||||
|
||||
Layout
|
||||
- docs/ — human‑readable docs (getting started, workflow, CI, style)
|
||||
- COMMON/ CTO/ COO/ CCO/ — questions, proposals, and prompt modules only
|
||||
- scripts/ — Makefile and helper scripts
|
||||
- docker/ — CI compose and Dockerfile
|
||||
- dist/prompts/ — generated prompt packs (cto.md, coo.md)
|
||||
- proposals/, questions/ — repository planning artifacts
|
||||
|
||||
Quickstart
|
||||
- Install hooks: `make -f scripts/Makefile hooks-setup`
|
||||
- Run checks: `make -f scripts/Makefile check`
|
||||
- Build prompt packs: `make -f scripts/Makefile prompts`
|
||||
|
||||
Docs
|
||||
- Git workflow: [docs/git-workflow.md](docs/git-workflow.md)
|
||||
- Local CI parity: [docs/bootstrap-cicd.md](docs/bootstrap-cicd.md)
|
||||
- Documentation style: [docs/docs-style.md](docs/docs-style.md)
|
||||
- Operational notes: [docs/RESUME.md](docs/RESUME.md), [docs/TODO.md](docs/TODO.md)
|
||||
- History: [docs/history/BOOTSTRAP.md](docs/history/BOOTSTRAP.md)
|
||||
|
Reference in New Issue
Block a user