Skip to content

docs: align ExecutorchModule docs after the C++ port#490

Merged
chmjkb merged 6 commits intomainfrom
@chmjkb/et-module-docs
Aug 13, 2025
Merged

docs: align ExecutorchModule docs after the C++ port#490
chmjkb merged 6 commits intomainfrom
@chmjkb/et-module-docs

Conversation

@chmjkb
Copy link
Copy Markdown
Collaborator

@chmjkb chmjkb commented Aug 4, 2025

Description

This PR changes the ExecutorchModule and the useExecutorchModule docs after the C++ port and the API refactor.

Introduces a breaking change?

  • Yes
  • No

Type of change

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Documentation update (improves or adds clarity to existing documentation)
  • Other (chores, tests, code style improvements etc.)

Tested on

  • iOS
  • Android

Testing instructions

Screenshots

Related issues

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings

Additional notes

@chmjkb chmjkb requested review from jakmro and mkopcins August 4, 2025 12:44
@chmjkb chmjkb marked this pull request as ready for review August 4, 2025 12:44
@chmjkb chmjkb linked an issue Aug 4, 2025 that may be closed by this pull request
Comment thread docs/docs/03-typescript-api/03-executorch-bindings/ExecutorchModule.md Outdated
@chmjkb chmjkb force-pushed the @chmjkb/et-module-docs branch from b9048f3 to 2977bb6 Compare August 13, 2025 06:53
@chmjkb chmjkb requested a review from jakmro August 13, 2025 06:53
Comment thread docs/docs/03-typescript-api/03-executorch-bindings/ExecutorchModule.md Outdated
Comment thread docs/docs/03-typescript-api/03-executorch-bindings/ExecutorchModule.md Outdated
@chmjkb chmjkb requested a review from jakmro August 13, 2025 07:57
@chmjkb chmjkb merged commit bffcd9f into main Aug 13, 2025
3 checks passed
@chmjkb chmjkb deleted the @chmjkb/et-module-docs branch August 13, 2025 14:29
mkopcins pushed a commit that referenced this pull request Oct 15, 2025
## Description

This PR changes the ExecutorchModule and the useExecutorchModule docs
after the C++ port and the API refactor.

### Introduces a breaking change?

- [ ] Yes
- [ ] No

### Type of change

- [ ] Bug fix (change which fixes an issue)
- [ ] New feature (change which adds functionality)
- [x] Documentation update (improves or adds clarity to existing
documentation)
- [ ] Other (chores, tests, code style improvements etc.)

### Tested on

- [ ] iOS
- [ ] Android

### Testing instructions

<!-- Provide step-by-step instructions on how to test your changes.
Include setup details if necessary. -->

### Screenshots

<!-- Add screenshots here, if applicable -->

### Related issues

<!-- Link related issues here using #issue-number -->

### Checklist

- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have updated the documentation accordingly
- [ ] My changes generate no new warnings

### Additional notes

<!-- Include any additional information, assumptions, or context that
reviewers might need to understand this PR. -->
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.

Align docs with the current implementation of ExecutorchModule

2 participants