Merge pull request #11 from svc-design/codex/更新-readme.md-并创建子文档

Update README with docs reference

README.md

@@ -2,6 +2,9 @@
 
 This repository contains a collection of Ansible playbooks and roles for various infrastructure setups and service management tasks.
 
+For a quick overview of the directory layout see [docs/repo-structure.md](docs/repo-structure.md).
+Additional documentation is stored under the `docs/` folder.
+
 ## Playbook 角色说明
 
 1. playbooks/roles/docker：适用于简单的、单机环境的部署，主要使用 Docker 和 Docker Compose 进行容器化管理。
@@ -88,3 +91,9 @@ ansible-playbook -i inventory/k3s-cluster playbooks/init_grafana_alloy -D -C -l
 - Setup VPN gateway
 
 ansible-playbook -i inventory/hosts/all playbooks/common -l gateway -D
+
+## Documentation
+
+- [docs/gpu-k8s-role.md](docs/gpu-k8s-role.md) - How to run the GPU-enabled Kubernetes role.
+- [docs/repo-structure.md](docs/repo-structure.md) - Overview of repository layout.
+

docs/repo-structure.md

@@ -0,0 +1,19 @@
+# Repository Structure
+
+This repository combines Ansible playbooks with Kubernetes manifests and
+automation scripts. Below is a short overview of the key directories.
+
+| Directory | Purpose |
+|-----------|---------|
+| `playbooks` | Ansible playbooks and role definitions. |
+| `apps` | Flux HelmRelease and Kustomize files for applications. |
+| `clusters` | Kustomize overlays for different clusters referencing the `apps` definitions. |
+| `helmfiles` | Sample [helmfile](https://github.com/helmfile/helmfile) declarations. |
+| `helm` | Local Helm charts used in some playbooks. |
+| `inventory` | Example inventories and group variables for Ansible. |
+| `scripts` | Utility scripts such as cluster setup or secret management. |
+| `sync` | Tasks for local host setup and testing. |
+| `docs` | Additional documentation. |
+
+See `docs/gpu-k8s-role.md` for an example walkthrough deploying a GPU-enabled
+Kubernetes cluster.