Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace example room IDs and alias with better ones #3654

Open
luixxiul opened this issue Oct 21, 2024 · 1 comment
Open

Replace example room IDs and alias with better ones #3654

luixxiul opened this issue Oct 21, 2024 · 1 comment
Labels
docs This issue is related to documentation suggestion This issue is a feature request

Comments

@luixxiul
Copy link
Collaborator

luixxiul commented Oct 21, 2024

Describe the bug
#3653 replaced room IDs and alias with ones on the Matrix Specification.

See:

However, it is not quite clear that those IDs and alias are example, and it should be considered what kind of strings indicate room IDs and aliases better, such as:

  • !example:example.com
  • !exampleRoom:example.com
  • !example1:example.com, !example2:example.com
  • !room1:example.com, !room2:example.com
  • !alicesRoom:example.com, !bobsRoom:example.com

To Reproduce

Expected behavior: Choose a better example room ID and alias ahead of Matrix Protocol itself, and track them on a style guide

Matrix Server:

Ansible:

Client:

Additional context
Taking them as an issue on https://github.com/matrix-org/matrix-spec-proposals would be an idea, though I am not sure whether the proposal could be picked up as friendly or hostile.

@altsalt
Copy link
Contributor

altsalt commented Oct 21, 2024

I like the idea of addressing it in the spec itself. The pushback would likely be that room IDs are going to be randomized strings rather than a word. This could create confusion when people can't set the room IDs themself. I do think at least having a consistent random example may be better.

@luixxiul luixxiul added suggestion This issue is a feature request docs This issue is related to documentation labels Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is related to documentation suggestion This issue is a feature request
Projects
None yet
Development

No branches or pull requests

2 participants