docs: add a runnable config inspection example - #20
Merged
Conversation
A standalone example makes the downstream use case understandable without turning environment naming into library policy. Keep it in a non-published workspace crate so normal builds and lints still verify it.
Flattening, internal tagging, newtype variants, and field renames already have focused derive coverage. The runnable example now owns the end-to-end consumer story, so keeping this assertion bundle would duplicate behavior without protecting a distinct contract.
The runnable showcase has its own dependencies and release lifecycle. Keeping it in a non-published root workspace crate leaves the published serde-shape manifest focused while preserving workspace-wide build and lint coverage.
tisonkun
marked this pull request as ready for review
September 1, 2026 16:29
tisonkun
enabled auto-merge (squash)
September 1, 2026 16:29
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
serde-shape-examplesworkspace crate with aninspect_configexample that prints an environment-variable reference for a fictional application configuration;configenvintegration fixture because its Serde behaviors already have focused derive coverage.Design notes
The example has its own local crate because showcase dependencies and targets should not affect the published
serde-shapemanifest. As a workspace member, it is still compiled and linted by the existing all-target workflow.Environment naming and shape support remain example policy rather than public library API. The walker handles the small set used by the fictional model, detects recursive definitions, and rejects representations it cannot map faithfully.
The example contains no names, paths, or configuration details from private downstream repositories.
Validation
cargo run --package serde-shape-examples --example inspect_configcargo x buildcargo x testcargo x lintcargo x package