search

matrix-org / matrix-spec

The Matrix protocol specification
Apache License 2.0
170 stars 90 forks source link

Rename and sort the modules in the feature profiles table for easier skimming #1855

Closed Johennes closed 5 days ago

Johennes commented 3 weeks ago

This renames the modules in the table to match the section titles and orders the table alphabetically within the two subsections of modules with and without requirements.

Adding the modules that were missing in v1.10 has been moved out into https://github.com/matrix-org/matrix-spec/pull/1860.

Fixes: #1437

Pull Request Checklist

Preview: https://pr1855--matrix-spec-previews.netlify.app

Johennes commented 2 weeks ago

Ok, I can do that. Where would you suggest I insert the missing modules in the existing order?

turt2live commented 2 weeks ago

We typically just append them to the end, for better or worse. If they're "required" (they shouldn't be), put them under the existing required ones.

Johennes commented 2 weeks ago

I pushed #1860 which merely adds the three missing modules without touching the table ordering.

Johennes commented 2 weeks ago

The brief discussion in the matrix-spec room was, sadly, inconclusive. The suggested options so far are:

  1. Sort alphabetically
  2. Sort by section occurrence
  3. Sort by requiredness (this is more or less how the table is sorted currently)
  4. Sort by requiredness first and alphabetically second

As a middleground, I updated the PR to match option 4 but also renamed those rows where the module name didn't match the section title. This should hopefully still make it easy enough to cross-reference the table with the sections.

For convenience, the PR can be reviewed by commit:

Johennes commented 2 weeks ago

CC @uhoreg / @anoadragon453 since you participated in the chat in matrix-spec.