From c5c35cd3b458ce41169d9b108541fadc8589e025 Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Tue, 19 May 2026 19:46:40 -0500 Subject: [PATCH] Moved example configuration from docs/examples/ to top-level examples/ --- README.md | 2 +- docs/config.md | 12 ++++++------ docs/development.md | 6 +++--- docs/troubleshooting.md | 2 +- .../pipeline.full.annotated.yml | 0 {docs/examples => examples}/pipeline.minimal.yml | 0 {docs/examples => examples}/pipeline.production.yml | 0 {docs/examples => examples}/session.local-audio.yml | 0 {docs/examples => examples}/session.s3-audio.yml | 0 {docs/examples => examples}/session.template.yml | 0 internal/config/load_validate_test.go | 2 +- 11 files changed, 12 insertions(+), 12 deletions(-) rename {docs/examples => examples}/pipeline.full.annotated.yml (100%) rename {docs/examples => examples}/pipeline.minimal.yml (100%) rename {docs/examples => examples}/pipeline.production.yml (100%) rename {docs/examples => examples}/session.local-audio.yml (100%) rename {docs/examples => examples}/session.s3-audio.yml (100%) rename {docs/examples => examples}/session.template.yml (100%) diff --git a/README.md b/README.md index 6791611..0ba1910 100644 --- a/README.md +++ b/README.md @@ -19,4 +19,4 @@ This command requires discoverable `pipeline.yml` and `session.yml` files (or ex - [Development Guide](docs/development.md) - [Architecture Principles](docs/architecture.md) - [Internal Component Contracts](docs/internal/README.md) -- [Config Examples](docs/examples/) +- [Config Examples](examples/) diff --git a/docs/config.md b/docs/config.md index 21907cc..197141b 100644 --- a/docs/config.md +++ b/docs/config.md @@ -294,11 +294,11 @@ Guidance: Maintained examples: -- `docs/examples/pipeline.minimal.yml` -- `docs/examples/pipeline.production.yml` -- `docs/examples/pipeline.full.annotated.yml` -- `docs/examples/session.template.yml` -- `docs/examples/session.local-audio.yml` -- `docs/examples/session.s3-audio.yml` +- `examples/pipeline.minimal.yml` +- `examples/pipeline.production.yml` +- `examples/pipeline.full.annotated.yml` +- `examples/session.template.yml` +- `examples/session.local-audio.yml` +- `examples/session.s3-audio.yml` These examples are validated by `internal/config` tests. diff --git a/docs/development.md b/docs/development.md index fa3986a..af93974 100644 --- a/docs/development.md +++ b/docs/development.md @@ -13,7 +13,7 @@ Canonical contributor workflow and engineering conventions for implemented Narra - `internal/manifest/`: session/run manifest types and persistence. - `internal/artifacts/`: canonical local/remote path helpers and local artifact store. - `docs/`: canonical documentation set. -- `docs/examples/`: maintained config examples used by tests. +- `examples/`: maintained config examples used by tests. ## Build and test commands @@ -61,7 +61,7 @@ For design principles and invariants, see [docs/architecture.md](./architecture. 4. Add or update load/validate tests in `internal/config/*_test.go`. 5. Update canonical config docs and examples: - [docs/config.md](./config.md) - - relevant files under `docs/examples/` + - relevant files under `examples/` ### Add CLI flags or commands @@ -79,7 +79,7 @@ For design principles and invariants, see [docs/architecture.md](./architecture. ### Update examples -1. Keep canonical examples only in `docs/examples/`. +1. Keep canonical examples only in `examples/`. 2. Ensure examples load and validate through runtime config paths. 3. Update `internal/config/load_validate_test.go` as needed. 4. Update links in `docs/config.md` if example filenames change. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index a6cf4b7..1c54076 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -70,7 +70,7 @@ Safe Fix: Links: - [docs/config.md](./config.md) -- [docs/examples/](./examples/) +- [examples/](../examples/) ## `--artifacts` selection failure diff --git a/docs/examples/pipeline.full.annotated.yml b/examples/pipeline.full.annotated.yml similarity index 100% rename from docs/examples/pipeline.full.annotated.yml rename to examples/pipeline.full.annotated.yml diff --git a/docs/examples/pipeline.minimal.yml b/examples/pipeline.minimal.yml similarity index 100% rename from docs/examples/pipeline.minimal.yml rename to examples/pipeline.minimal.yml diff --git a/docs/examples/pipeline.production.yml b/examples/pipeline.production.yml similarity index 100% rename from docs/examples/pipeline.production.yml rename to examples/pipeline.production.yml diff --git a/docs/examples/session.local-audio.yml b/examples/session.local-audio.yml similarity index 100% rename from docs/examples/session.local-audio.yml rename to examples/session.local-audio.yml diff --git a/docs/examples/session.s3-audio.yml b/examples/session.s3-audio.yml similarity index 100% rename from docs/examples/session.s3-audio.yml rename to examples/session.s3-audio.yml diff --git a/docs/examples/session.template.yml b/examples/session.template.yml similarity index 100% rename from docs/examples/session.template.yml rename to examples/session.template.yml diff --git a/internal/config/load_validate_test.go b/internal/config/load_validate_test.go index 2c2bc6a..93d1648 100644 --- a/internal/config/load_validate_test.go +++ b/internal/config/load_validate_test.go @@ -891,7 +891,7 @@ func TestValidateMissingAudioSource(t *testing.T) { } func TestExamplesLoadAndValidate(t *testing.T) { - examplesDir := filepath.Join("..", "..", "docs", "examples") + examplesDir := filepath.Join("..", "..", "examples") tests := []struct { name string pipelineFile string