Skip to content

[WEB-4460] fix: preserve lang param in content links #2690

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

Merged
merged 1 commit into from
Jun 30, 2025

Conversation

jamiehenson
Copy link
Member

@jamiehenson jamiehenson commented Jun 27, 2025

Raised by @m-hulbert.

Links in content in MDX pages need to preserve any active lang params so that we get a consistent language experience between pages.

Review: https://ably-docs-web-4440-pres-2duhlf.herokuapp.com/docs/chat/rooms?lang=react

@ably-ci ably-ci temporarily deployed to ably-docs-web-4440-pres-2duhlf June 27, 2025 16:14 Inactive
Copy link

coderabbitai bot commented Jun 27, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@jamiehenson jamiehenson force-pushed the web-4440-preserve-content-params branch from 7f31677 to 2a1db61 Compare June 27, 2025 16:19
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4440-pres-2duhlf June 27, 2025 16:20 Inactive
@jamiehenson jamiehenson force-pushed the web-4440-preserve-content-params branch from 2a1db61 to deeea70 Compare June 27, 2025 16:30
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4440-pres-2duhlf June 27, 2025 16:31 Inactive
@jamiehenson jamiehenson requested a review from m-hulbert June 27, 2025 16:32
Copy link
Contributor

@m-hulbert m-hulbert left a comment

Choose a reason for hiding this comment

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

Works perfectly for MDX, but we also seem to have introduced a regression to textile whenever we broke this. Happy to approve this and deal with textile separately, or include it in here - whichever is easiest.

@jamiehenson
Copy link
Member Author

@m-hulbert I'll take a look and let you know if it's a disproportionately large faff

@jamiehenson jamiehenson force-pushed the web-4440-preserve-content-params branch from deeea70 to d45e439 Compare June 30, 2025 10:50
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-4440-pres-2duhlf June 30, 2025 10:50 Inactive
@jamiehenson jamiehenson changed the title [WEB-4460] fix: preserve lang param in mdx content links [WEB-4460] fix: preserve lang param in content links Jun 30, 2025
@jamiehenson jamiehenson requested a review from m-hulbert June 30, 2025 10:57
Copy link
Contributor

@m-hulbert m-hulbert left a comment

Choose a reason for hiding this comment

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

🚀

@jamiehenson jamiehenson merged commit 43c029e into main Jun 30, 2025
6 checks passed
@jamiehenson jamiehenson deleted the web-4440-preserve-content-params branch June 30, 2025 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants