common-conventions

name	common-conventions
description	Conventions shared by the in-repo binaries (edgion-controller, edgion-gateway, edgion-cli) — project overview, command line / directory / config-path conventions, Core layering conventions, resource system.

00 Common conventions

This directory describes the foundational conventions shared by the in-repo binaries. It is recommended to read this first before reading the architecture documentation for any specific binary.

File index

File	Topic	Recommended reading scenario
00-project-overview.md	Project overview: high-level architecture diagram, Crate structure, key dependencies	First contact with the project, when a global view is needed
01-cli-and-startup.md	Unified command-line conventions, working directory, config-file paths	Modifying startup arguments, understanding config loading
02-core-layout.md	Core module layering conventions, placement rules	Adding new modules, avoiding regression to old directory structures
03-resource-system.md	Resource system: define_resources! macro, ResourceMeta, ResourceKind, Preparse	Adding a new resource type, understanding the resource abstraction
04-grouped-list-pattern.md	Design contract for list-shaped fields with named groups (IP / key / regex / issuer / origin lists): when to group, schema/serde/CRD/rolling-upgrade rules, first-wins + warn, group-in-ok-log iron rule	Adding or extending any *_groups field; designing a new list resource

The Secret → Material resolution layer (full Resolver table, Controller/Gateway responsibility split, Zeroize scope) has been merged into ../05-resources/10-secret.md.