element-hq / element-hq/element-meta

Add documentation that lists custom well-known properties

Open
#1,602 0 comments 2 reactions 0 assignees View on GitHub
A-Documentation
Dominant language
No language data
Stars
112
Forks
25
Avg merge
6h 6m
Merged PRs (30d)
4

Description

Currently Element supports two custom properties in the client well-known file, which are documented in two different files:

* https://github.com/vector-im/element-web/blob/develop/docs/jitsi.md
* https://github.com/vector-im/element-web/blob/develop/docs/e2ee.md

It would be useful to know from a glance whether a specific feature depends from a well-known property. i.e., it would be nice to have a document that lists existing ones, and this document could link to each property's individual doc file for more documentation.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing docs/jitsi.md and docs/e2ee.md in the linked Element Web repository to identify the documented custom well-known properties. Add a document that lists the existing properties and links to each property's detailed documentation. Done means the properties can be found from one overview document.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.