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

Docs spec version inconsistencies. #14777

Open
matrixbot opened this issue Dec 20, 2023 · 0 comments
Open

Docs spec version inconsistencies. #14777

matrixbot opened this issue Dec 20, 2023 · 0 comments

Comments

@matrixbot
Copy link
Collaborator

matrixbot commented Dec 20, 2023

This issue has been migrated from #14777.


So in the process of making #14111 i ran into that the docs refer to diffrent versions of the spec in a somewhat inconsistent manner. Some places refer to specific spec versions and others to latest. Im not sure if there is a specific reason as to why specific places should use one or the other but im filing this issue to document this.

Its logical that the list of room versions for example targets /latest/ but the case can also be made for this in other areas. The example i currently know about in the docs is for the config option rc_invites under the config documentation. There might be more examples but im aware of this example as it came up when i did a find operation in the config_documentation.md file as my PR touches this file.

A search in my copy of the docs (This copy im searching is for a copy of develop that is old so might be out of date) says that this shows up in other files.

A probably complete list of files where specific spec versions are referenced.

  • upgrade.md
  • rooms.md
  • database_schema.md
  • understanding_synapse_through_grafana_graphs.md
  • reporting_homeserver_usage_statistics.md
  • config_documentation.md
  • password_auth_provider_calllbacks.md

A list containing files that mention latest. (Overlap means the file mentions both)

  • media_repository.md
  • sso_mapping_providers.md
  • rooms.md
  • user_admin_api.md
  • password_auth_provider_calllbacks.md
  • config_documentation.md

And then we have in the file CHANGES-2021.md on line 1829 where we refer to the unstable spec.

This should be a somewhat complete set of all times in the docs section of this repo we mention the string spec.matrix.org/ that i searched for. The changelog entry i personally would conclude is not related to the details of this issue.

@matrixbot matrixbot changed the title Dummy issue Docs spec version inconsistencies. Dec 21, 2023
@matrixbot matrixbot reopened this Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant