Moved example configuration from docs/examples/ to top-level examples/
All checks were successful
ci/woodpecker/tag/release Pipeline was successful

This commit is contained in:
2026-05-19 19:46:40 -05:00
parent 574b1cde6c
commit c5c35cd3b4
11 changed files with 12 additions and 12 deletions

View File

@@ -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/)

View File

@@ -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.

View File

@@ -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.

View File

@@ -70,7 +70,7 @@ Safe Fix:
Links:
- [docs/config.md](./config.md)
- [docs/examples/](./examples/)
- [examples/](../examples/)
## `--artifacts` selection failure

View File

@@ -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