help: Do not allow autolinks for help center docs. #30453
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mdxjs does not allow autolinks. See mdx-js/mdx#1049. We also added a linter check for the same. Preparatory commit for zulip#30451.
timabbott
reviewed
Jun 17, 2024
| "description": """Autolinks are not allowed in /help documentation due to the upcoming migration to mdx. | ||
| Use Linkified markdown URLs [url](url) instead. | ||
| See https://github.com/mdx-js/mdx/issues/1049 for more info.""", | ||
| "include_only": {"help/"}, |
There was a problem hiding this comment.
This is OK, but I'd usually write this copy in a way that doesn't require a future update after we actually migrate to MDX, since it's a small extra TODO list item for that migration. I don't have an easy proposal for that purpose, so probably the TODO is fine.
|
Merged, thanks @shubham-padia! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
mdxjs does not allow autolinks.
See mdx-js/mdx#1049.
We also added a linter check for the same.
Preparatory commit for #30451.
Fixes:
Screenshots and screen captures:
Self-review checklist
(variable names, code reuse, readability, etc.).
Communicate decisions, questions, and potential concerns.
Individual commits are ready for review (see commit discipline).
Completed manual review and testing of the following: