Skip to content

[Docs] Clarify overlay visibility semantics#40

Merged
samzong merged 1 commit into
mainfrom
docs/overlay-visibility-semantics
May 26, 2026
Merged

[Docs] Clarify overlay visibility semantics#40
samzong merged 1 commit into
mainfrom
docs/overlay-visibility-semantics

Conversation

@samzong

@samzong samzong commented May 26, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Rename the internal overlay field for legacy parameter hidden to DeprecatedAlias while preserving the YAML key for compatibility.
  • Keep param.hidden behavior mapped to deprecated flags and cover both deprecated: true and legacy hidden: true in render tests.
  • Clarify command ignore, command hidden, and parameter hidden semantics in README and architecture docs.

Verification

  • go test ./internal/overlay ./internal/codegen/render
  • git diff --check
  • make check

Compatibility

  • Existing overlays using params.<name>.hidden: true remain supported and continue to mark the flag deprecated.
  • No runtime schema, catalog schema, generated command shape, auth/body/output behavior, or generated output changes.

Checklist

  • Tests or focused verification cover the changed surface.
  • User-facing behavior changes are documented.
  • Generated output under internal/generated/, .cache/, and ad-hoc skills/<cli-name>/ directories is not committed.
  • Commits are signed off when this is ready to merge.

Signed-off-by: samzong <samzong.lu@gmail.com>
@samzong
samzong merged commit d2e7f4a into main May 26, 2026
3 checks passed
@samzong
samzong deleted the docs/overlay-visibility-semantics branch June 26, 2026 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant