matrix-org / matrix-org/cerulean
Add notice about homeserver support in the README
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 106
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
Relates to #43
We should add a notice somewhere on this repo that Cerulean does not work with Synapse at the moment to avoid users getting stuck.
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
Open the README and find the most appropriate location for a homeserver compatibility notice. Add a clear statement that Cerulean does not currently work with Synapse, then verify the README communicates this before users get stuck.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100