Commit 1fa0f072 authored by xuwang's avatar xuwang
Browse files

docs(readme): remove outdated Framework Structure section

parent b1a9ebfc
Loading
Loading
Loading
Loading
+0 −24
Original line number Diff line number Diff line
@@ -144,30 +144,6 @@ Notes:
  `vX.Y.Z` tag (what consumers pin) is present on both; the rich Release page
  lives on code.stanford.edu.

## Framework Structure

```
~/.otica/
├── README.md         # This file
├── CONTRIBUTING.md   # Contributor workflow, conventions, changelog trailers
├── LICENSE
├── VERSION           # Current framework version (semver; source of truth)
├── CHANGELOG.md      # Release notes (generated from Changelog: trailers)
├── Makefile          # Developer-only: validation + release targets for this repo
├── makefiles/        # Reusable Makefile modules — one per platform/feature (azure, gcp,
│                     #   gke, aws, docker, kube, terraform, vault, opa, gitlab, …)
├── scripts/          # Shell helpers added to PATH by help.mk (cloud login/logout, template
│                     #   rendering, Vault ops, GitLab/release tooling, confirm prompt, …)
├── envs/             # Environment config templates (otica/azure/gcp/aws/tf -env.mk)
├── helm-charts/      # Helm chart templates
├── tests/            # Validation harness (see `make validate`)
└── .gitlab/          # Changelog category config for the GitLab generator
```

The authoritative per-module/per-script reference is generated, not hand-maintained:
run `make help` for targets, `ls scripts/` for scripts, or see the
[Technical Reference](docs/OTICA_TECHNICAL_REFERENCE.md#module-reference).

## Examples

Examples live in their own repo tree, not in this framework checkout: