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

Stop rendering CS modules and room version fragments as standalone pages #1317

Merged
merged 5 commits into from
Nov 8, 2022

Conversation

richvdh
Copy link
Member

@richvdh richvdh commented Nov 2, 2022

This is actually doing two things:

  • creating {fragments,modules}/index.md turns the fragments and modules into page resources, rather than pages in their own right. We have to update the shortcodes to match, but we can also remove the filtering from the sidebar and the frontmatter from the module definitions.

  • adding headless: true means that we don't render the pages.

The net effect is that we don't render pages like https://spec.matrix.org/v1.4/rooms/fragments/v1-auth-rules/ and https://spec.matrix.org/v1.4/client-server-api/modules/account_data/.

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

This is actually doing two things:

 * creating `{fragments,modules}/index.md` turns the fragments and modules into
   page resources, rather than pages in their own right. We have to update the
   shortcodes to match.

 * adding `headless: true` means that we don't render the pages.

The net effect is that we don't render pages like
https://spec.matrix.org/v1.4/rooms/fragments/v1-auth-rules/ and
https://spec.matrix.org/v1.4/client-server-api/modules/account_data/.
@richvdh richvdh requested a review from a team as a code owner November 2, 2022 22:30
@richvdh richvdh changed the title Turn room version fragments and cs modules into headless resources Stop rendering CS modules and room version fragments as standalone pages Nov 2, 2022
Copy link
Member

@dbkr dbkr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems plausible

@richvdh richvdh merged commit b07fe50 into main Nov 8, 2022
@richvdh richvdh deleted the rav/no_render_fragments branch November 8, 2022 17:27
clokep pushed a commit to clokep/matrix-spec that referenced this pull request May 3, 2023
…ges (matrix-org#1317)

This is actually doing two things:

 * creating `{fragments,modules}/index.md` turns the fragments and modules into
   page resources, rather than pages in their own right. We have to update the
   shortcodes to match.

 * adding `headless: true` means that we don't render the pages.

The net effect is that we don't render pages like
https://spec.matrix.org/v1.4/rooms/fragments/v1-auth-rules/ and
https://spec.matrix.org/v1.4/client-server-api/modules/account_data/.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants