[WEB-4356] Fixed github edit links, MDX canonicals, adds examples product param, updated realtime terminology

[jamiehenson]

As the title suggests this fixes five things:

• sorts out the Edit on Github links on pages by introducing/changing the following: tracking whether a page is mdx or textile, explicitly declaring whether a page is a section index or not (improves link accuracy), and introducing support for custom pages like how-to/pub-sub which live in an atypical place
• adds the ability to view the examples index page with a product pre-applied, by supplying a ?product=X query param to the URL. This works for multiple products at once, by setting the param as a comma separated list i.e. ?product=X,Y,Z
• updates "real-time" terminology to be realtime for consistency
• fixes an EISDIR directory access error when building (comes up on prod builds and blocks local builds)
• uses Gatsby location over path as the source for canonical links to fix indexing issues on MDX pages

To review:

• The Edit on Github link should work on an MDX page: https://ably-docs-canonicals-ex-erumkb.herokuapp.com/docs/chat/rooms
• It should work on a Textile page: https://ably-docs-canonicals-ex-erumkb.herokuapp.com/docs/getting-started/setup
• It should work on how-to/pub-sub: https://ably-docs-canonicals-ex-erumkb.herokuapp.com/docs/how-to/pub-sub
• This link should open Examples with Pubsub and Chat pre-selected https://ably-docs-canonicals-ex-erumkb.herokuapp.com/examples?product=pubsub,chat
• Clicking other product filters should update the param accordingly
• On an MDX page, view the page source (i.e. not in the inspector, the server version) and ensure that the canonical link is correctly set to the current path

[coderabbitai[bot]]

[!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]

Should this also be updating the index param for API referneces or are they handled separately?

@m-hulbert api references should be included in this - are there any that I've missed?

[m-hulbert]

Should this also be updating the index param for API referneces or are they handled separately?

@m-hulbert api references should be included in this - are there any that I've missed?

Ah ignore me... I forgot that they're structured a little differently.