matrix-org / matrix-org/matrix-spec

Grammar for room aliases (SPEC-391)

Open
#176 8 comments 1 reaction 0 assignees View on GitHub
feature
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Room aliases are intended to be
- human-readable
- unique

They have some structure: `#:`.

We need to specify a grammar for them, including which characters they may contain, and how they should be interpreted. Can they contain punctuation or whitespace characters? Should they be allowed to contain non-ascii characters, and if so, how should they be normalised? Should they be case-insensitive, and if so, in what locale?

(Imported from https://matrix.org/jira/browse/SPEC-391)

(Reported by @richvdh)

Contributor guide

Open the contributing guide

Research direction

Start with the room-alias structure described in the issue and review the imported SPEC-391 context. Resolve the open questions about allowed characters, whitespace, non-ASCII normalization, and case handling, then document the grammar and interpretation rules in the Matrix specification.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.