Skip to content

[CSA-CP] MATTER-5943: Implement common file for CRTP documentation - #1256

Merged
Michael Duggan (miduggan24) merged 1 commit into
release_2.10-1.6.1from
cp/common_doc
Oct 15, 2026
Merged

Michael Duggan (miduggan24) merged 1 commit into
release_2.10-1.6.1from
cp/common_doc

Conversation

@miduggan24

@miduggan24 Michael Duggan (miduggan24) commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Summary

As part of linked ticket, common file is implemented in docs space for CRTP documentation to avoid duplication across apps
https://github.com/SiliconLabsSoftware/docs-matter/pull/68/changes

This doc however is not suitable for matter_sdk as some references (in particular links to file locations) are not accurate for this repo.

Implement common doc in docs/platforms/silabs/silabs_extending_base_app_implementation.md and link to this from all app README files.

Keep EVSE and closure specific documentation (for energy management and ClosureManager respectively)

Related issues

MATTER-5943

Testing

n/a docs only

@silabs-matter-ci-bot silabs-matter-ci-bot Bot added the csa-cp This TAG indicates that this commit is a cherry-pick from a CSA commit. label Oct 15, 2026
@miduggan24
Michael Duggan (miduggan24) marked this pull request as ready for review October 15, 2026 13:14
@miduggan24
Michael Duggan (miduggan24) requested a review from a team as a code owner October 15, 2026 13:14
@cursor

cursor Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only refactor with no runtime or build changes.

Overview
Adds a single Silicon Labs platform guide at docs/platforms/silabs/silabs_extending_base_app_implementation.md for customizing sample apps via CustomerAppTask and CRTP *Impl() hooks (override workflow, data model callback routing post–Matter Extension 2.9.0, lighting-style sample code, and StartAppTask notes). The guide uses matter_sdk–accurate paths to examples/platform/silabs/customer/ and related sources.

Registers the page on docs/platforms/silabs/index.md and replaces large duplicated “Extending Base App Implementation” blocks in many Silabs example READMEs with a short link to the shared doc plus pointers to each app’s include/AppTaskImpl.h and src/AppTask.cpp.

Closure and EVSE READMEs still carry app-specific material: closure keeps CustomerAppManager / ClosureManager CRTP docs; EVSE keeps Energy Management Hardware Integration (delegates not yet on CRTP).

Reviewed by Cursor Bugbot for commit 7cbfc83. Configure here.

@miduggan24
Michael Duggan (miduggan24) merged commit 43f79d6 into release_2.10-1.6.1 Oct 15, 2026
90 checks passed
@miduggan24
Michael Duggan (miduggan24) deleted the cp/common_doc branch October 15, 2026 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

csa-cp This TAG indicates that this commit is a cherry-pick from a CSA commit.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants