Cleaned up documentation language
This commit is contained in:
@@ -14,16 +14,15 @@ ConfigKit and PromptKit provide native YAML configuration inspection. Reusing
|
||||
their writers preserves captured value semantics, ordering, and redaction. YAML
|
||||
also supports automated consumption of structured reports.
|
||||
|
||||
The agreed initial direction is YAML-based structured inspection with JSON
|
||||
deferred, and separate native documents for `config show --scope all`. The
|
||||
remaining choices concern report defaults, document framing, and when output
|
||||
begins relative to configuration loading.
|
||||
The agreed initial direction is YAML-based structured inspection and separate
|
||||
native documents for `config show --scope all`. The remaining choices concern
|
||||
report defaults, document framing, and when output begins relative to
|
||||
configuration loading.
|
||||
|
||||
## Decision
|
||||
|
||||
The initial standard uses text for concise operator reports and YAML for
|
||||
structured consumption. JSON retains deferred status; a future format extension
|
||||
is evaluated against a concrete consumer need.
|
||||
structured consumption.
|
||||
|
||||
| Operation | Default report | Available initial formats |
|
||||
| --- | --- | --- |
|
||||
@@ -78,6 +77,7 @@ Report confidentiality follows the owning libraries' sensitivity classifications
|
||||
Their safe writers and records supply redacted content. CommandKit preserves
|
||||
those confidentiality semantics; arbitrary caller content retains the caller's
|
||||
disclosure policy.
|
||||
|
||||
Report delivery uses the supplied streams and the channel policy in ADR 0005.
|
||||
Configuration path syntax follows ConfigKit's JSON Pointer contract independently
|
||||
of serialization format.
|
||||
|
||||
Reference in New Issue
Block a user