Skip to content

MATTER-5857: Update the API Reference section of the documentation - #72

Merged
Michael Duggan (miduggan24) merged 12 commits into
doccurator/2.9.2from
docs/MATTER-5857
Sep 24, 2026
Merged

Michael Duggan (miduggan24) merged 12 commits into
doccurator/2.9.2from
docs/MATTER-5857

Conversation

@miduggan24

Copy link
Copy Markdown
Contributor

Description

The API Reference section of matter docspace is outdated. With the effort of supporting per-app APIs in project upgrades refactor, the best thing to do with this docleaf is to expose the customization APIs that we support for each app to customers.

Related Issue

MATTER-5857

Changes Made

  • Migrate Extending Base App Implementation content from custom-matter-device.md to sld295-matter-api-reference/index.md
  • Update references across docspace from previous Extending Base App Implementation links to Matter API Reference links
  • Introduce per-app API reference pages with public API, function to override, and brief description of the API
  • Delete outdated/unused pages in docleaf
    • attributes.md
    • cluster-implementation.md
    • cluster.md
    • commands.md
    • datamodeltypes.md
    • event.md

Checklist

Screenshots (if applicable)

n/a

Additional Notes

n/a

@cursor

cursor Bot commented Sep 16, 2026 •

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only reorganization and link updates; no runtime or SDK code changes.

Overview
Restructures the Matter API Reference docleaf so customization guidance lives in one place and is organized per sample app.

The long Extending Base App Implementation section (CRTP/CustomerAppTask, ClosureManager, sample code, autogen file table) moves from custom-matter-device.md into sld295-matter-api-reference/index.md, with workflow tweaks such as pointing readers at app-specific *Impl() names. Custom Matter Device now defers to the API reference with a short link.

Adds 14 app-specific override API pages (Lighting, Lock, Closure, etc.) as tables mapping *Impl() hooks to public APIs and default behavior; Closure documents a separate CustomerAppManager chain.

Removes legacy generic API pages (attributes, cluster, commands, datamodeltypes, event, cluster-implementation). Updates cross-links on the landing page and application-development guides to /matter-api-reference/ instead of the old custom-device anchor.

Reviewed by Cursor Bugbot for commit 57d3684. Configure here.

@miduggan24
Michael Duggan (miduggan24) changed the base branch from main to doccurator/2.9.2 September 16, 2026 13:44
Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>
@miduggan24

Copy link
Copy Markdown
Contributor Author

silabs-BhoomikaB applied comments from air quality across all apps in dc093a7

Comment thread sld295-matter-api-reference/evse-app.md Resolved
Comment thread sld295-matter-api-reference/index.md Resolved
Comment thread sld295-matter-api-reference/index.md Resolved
Comment thread sld295-matter-api-reference/index.md Resolved
Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>
@miduggan24
Michael Duggan (miduggan24) merged commit b4f8036 into doccurator/2.9.2 Sep 24, 2026
@miduggan24
Michael Duggan (miduggan24) deleted the docs/MATTER-5857 branch September 24, 2026 13:23
silabs-BhoomikaB added a commit that referenced this pull request Oct 21, 2026
* MATTER-5857: Update the API Reference section of the documentation (#72)

* refactor api reference docspace

* Apply batched suggestions from code review

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* apply common edits across app files

* Apply batched suggestions from code review

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* Update sld295-matter-api-reference/air-quality-sensor-app.md

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* fix formatting issues from batch application

* Apply batched suggestions from code review

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* Apply batched suggestions from code review

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* Apply batched suggestions from code review

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* apply review comment

* Apply batched suggestions from code review

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* fix formatting issue from code review

---------

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* MATTER-6894: Update the version strings to 2.9.2 (#75)

* Update the version strings to 2.9.2

* Update New Features for 2.9.2

* SS5 to SS6

DOCS-1197: Updated SS5 refs to SS6

* Add a link to the custom cluster section (#76)

* Add a link to the custom cluster section

* Apply suggestion from @silabs-BhoomikaB

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* Apply suggestion from @silabs-BhoomikaB

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

---------

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* Update fas (#79)

* MATTER-5943: Add customer documentation for project upgrades (#68)

* add common customization documentation, remove new/legacy architecture references

* add ref to lighting app in example code snippet

* add version to datamodelcallbacks reference

* reword link

* address review coments

* address review comments

* Update the version strings to 2.9.1 and add New Features (#69)

* Update the version strings to 2.9.1 and add New Features

* Added note for MatterHub image and reverted to previous link

* Resolved conflicts

* Update sld249-matter-prerequisites/matter-artifacts.md

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* Update sld290-matter-wifi-getting-started-example/index.md

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* Update sld388-matter-new-features/index.md

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

---------

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* Update custom-matter-device.md

Fixed a build issue.

* Update index.md (#77)

Updated FAS timeline to 8 weeks

* Update index.md for FAS timeline

Updated FAS timeline

---------

Co-authored-by: Michael Duggan <miduggan@silabs.com>
Co-authored-by: Arghya Dutta <arghya.dutta@silabs.com>
Co-authored-by: silabs-vm <vimorrow@silabs.com>

* Adding a new document for extending the EVSE Example (#74)

* Adding a new document for extending the EVSE Example

- Extending the base sample functionality of EVSE sample app
- Adding Simulated EV, and different state transitions.
- Adding steps to verify state transitions and matter commands.

Including image for states

Including image for EVSE states being exercised.

* Apply batched suggestions from code review

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* Apply batched suggestions from documentation review

Adding corrections by Bhoomika.

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

* Adding introduction to evse example

Adding a small introduction and an image to show how to visualize the different mattertool commands

* Apply batched suggestions from code review

adding suggestions after review

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

---------

Co-authored-by: silabs-BhoomikaB <Bhoomika.Bobbili@silabs.com>

---------

Co-authored-by: Michael Duggan <miduggan@silabs.com>
Co-authored-by: Arghya Dutta <arghya.dutta@silabs.com>
Co-authored-by: Sergei Lissianoi <54454955+selissia@users.noreply.github.com>
Co-authored-by: silabs-vm <vimorrow@silabs.com>
Co-authored-by: Diego Mayorga <93224078+silabs-dimayorg@users.noreply.github.com>
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.

4 participants