Skip to content

Update Component/Trait documentation to match current schema and patch semantics#134

Merged
ChathurangaKCD merged 2 commits into
mainfrom
update-componenttype-examples-to-match-cureent-state
Nov 27, 2025
Merged

Update Component/Trait documentation to match current schema and patch semantics#134
ChathurangaKCD merged 2 commits into
mainfrom
update-componenttype-examples-to-match-cureent-state

Conversation

@ChathurangaKCD

@ChathurangaKCD ChathurangaKCD commented Nov 26, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Purpose

  • Update Component API docs to use componentType {workloadType}/{componentTypeName} format and refresh examples
  • Clarify schema syntax (single pipe; space-separated constraints) in ComponentType/Trait docs
  • Remove deprecated mergeShallow op and adjust trait patch examples to use supported add paths

Related Issues

Include any related issues that are resolved by this PR.

Checklist

  • Updated sidebars.ts if adding a new documentation page
  • Run npm run start to preview the changes locally
  • Run npm run build to ensure the build passes without errors
  • Verified all links are working (no broken links)

@ChathurangaKCD ChathurangaKCD changed the title Update componenttype examples to match cureent state Update Component/Trait documentation to match current schema and patch semantics Nov 26, 2025
@ChathurangaKCD ChathurangaKCD force-pushed the update-componenttype-examples-to-match-cureent-state branch 2 times, most recently from 2c6a218 to 90d85e5 Compare November 26, 2025 05:23
@ChathurangaKCD ChathurangaKCD marked this pull request as ready for review November 26, 2025 05:25
@ChathurangaKCD ChathurangaKCD force-pushed the update-componenttype-examples-to-match-cureent-state branch 3 times, most recently from 8333480 to 6dbf934 Compare November 26, 2025 09:36
@ChathurangaKCD ChathurangaKCD force-pushed the update-componenttype-examples-to-match-cureent-state branch from 6dbf934 to feaca92 Compare November 26, 2025 09:37
@ChathurangaKCD ChathurangaKCD merged commit 56916f5 into main Nov 27, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@binura-g binura-g binura-g approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ChathurangaKCD @binura-g