generated from coulomb/repo-seed
Customize config-atlas identity (INTENT, SCOPE, AGENTS, rules), document dev workflow commands, remove inherited repo-seed workplans, and add ATLAS-WP-0002 registry foundation workplan.
64 lines
1.9 KiB
Markdown
64 lines
1.9 KiB
Markdown
# SCOPE
|
|
|
|
> Lightweight boundary for agents and contributors.
|
|
|
|
---
|
|
|
|
## One-liner
|
|
|
|
Federated configuration atlas — cataloging configuration surfaces, schemas,
|
|
defaults, ownership, and cross-repo relationships across the Coulomb ecosystem.
|
|
|
|
---
|
|
|
|
## Core Idea
|
|
|
|
`config-atlas` indexes **configuration surfaces**: bounded, named places where
|
|
configuration is defined, read, or overridden (files, env vars, APIs, feature
|
|
flags, policy bundles, deployment parameters). Each surface gets a registry entry
|
|
with ownership, scope, validation hooks, and links to canonical sources.
|
|
|
|
The atlas helps agents and operators answer:
|
|
|
|
1. What configuration exists for a repo, capability, or deployment context?
|
|
2. Who owns it and where is the source of truth?
|
|
3. What are the safe defaults and precedence rules?
|
|
4. Which other surfaces depend on or override it?
|
|
|
|
---
|
|
|
|
## In Scope
|
|
|
|
- Configuration surface registry (`registry/`) with indexes and capability entries
|
|
- Schema and naming conventions for atlas entries
|
|
- Cross-repo relationship documentation (consumes, overrides, extends)
|
|
- Contribution and validation workflow docs
|
|
- State Hub workplans and agent orientation files
|
|
|
|
---
|
|
|
|
## Out of Scope
|
|
|
|
- Secret values, credentials, or environment-specific live config
|
|
- Application runtime, deployment automation, or config push/pull engines
|
|
- Owning downstream repo implementations or their local config files
|
|
- Template bootstrap mechanics (`repo-seed` and `statehub register`)
|
|
|
|
---
|
|
|
|
## Current State
|
|
|
|
- State Hub integration bootstrapped (ATLAS-WP-0001).
|
|
- Inherited `repo-seed` registry and template docs pending replacement
|
|
(ATLAS-WP-0002).
|
|
- No application runtime; markdown-first registry and planning repo.
|
|
|
|
---
|
|
|
|
## Getting Oriented
|
|
|
|
- Start with: `INTENT.md`
|
|
- Agent instructions: `AGENTS.md`
|
|
- Workplans: `workplans/`
|
|
- Verify: `cat .custodian-brief.md` ; `ls workplans/` ; from `~/state-hub`:
|
|
`make fix-consistency REPO=config-atlas` |