matrix-org / matrix-org/matrix-widget-api
Widget example isn't documented on how to actually use it
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 95
- Forks
- 24
- Avg merge
- 16h 16m
- Merged PRs (30d)
- 1
Description
Need to yarn build the project, copy the dist/api.js to next to the index.html, and serve the widget off a web server of some sort.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running yarn build and inspect how the widget example uses index.html with the generated dist/api.js. Update the example documentation to explain copying dist/api.js beside index.html and serving it from a web server, then verify that the steps are complete and reproducible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, web-dev
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100