Skip to content

Conversation

@franrob-projects
Copy link
Contributor

@franrob-projects franrob-projects commented Oct 22, 2025

This PR:

  • Converts https://ably.com/docs/api/rest-ap to MDX

EDU-2113

@franrob-projects franrob-projects added the review-app Create a Heroku review app label Oct 22, 2025
@ably-ci ably-ci temporarily deployed to ably-docs-edu-2113-conv-jgqqz4 October 22, 2025 11:42 Inactive
@coderabbitai
Copy link

coderabbitai bot commented Oct 22, 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.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch EDU-2113-convert-rest-api-to-mdx

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@GregHolmes GregHolmes left a comment

Choose a reason for hiding this comment

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

Just a few comments after skimming through.

  • The header tags need to be in html format so <a id="" />
  • Any code blocks wrapped in ``` need to be wrapped in a
  • All ``` need to have a name/language with them. Even if it's just text I think.
  • List such as the below need to be converted to a 3 column table:
- Content-Type := not applicable
- Accept := `application/json` by default, or `application/x-msgpack`, `text/html`
- Auth required := yes ([basic](#basic-authentication) or [token](#token-authentication))

I think this may need to be looked at with your other PR too.

@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2113-conv-jgqqz4 October 23, 2025 12:38 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2113-conv-jgqqz4 October 23, 2025 13:51 Inactive
@franrob-projects franrob-projects force-pushed the EDU-2113-convert-rest-api-to-mdx branch from 3059b40 to 9627c34 Compare October 23, 2025 14:00
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2113-conv-jgqqz4 October 23, 2025 14:01 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2113-conv-jgqqz4 October 23, 2025 14:19 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2113-conv-jgqqz4 October 23, 2025 14:46 Inactive
@franrob-projects franrob-projects force-pushed the EDU-2113-convert-rest-api-to-mdx branch from a470b81 to 0a19148 Compare October 23, 2025 14:47
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2113-conv-jgqqz4 October 23, 2025 14:47 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2113-conv-jgqqz4 October 24, 2025 11:40 Inactive
@franrob-projects franrob-projects force-pushed the EDU-2113-convert-rest-api-to-mdx branch from ce21395 to 1e50c24 Compare October 24, 2025 11:40
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2113-conv-jgqqz4 October 24, 2025 11:40 Inactive
@franrob-projects
Copy link
Contributor Author

franrob-projects commented Oct 24, 2025

Just a few comments after skimming through.

  • The header tags need to be in html format so <a id="" />
  • Any code blocks wrapped in ``` need to be wrapped in a
  • All ``` need to have a name/language with them. Even if it's just text I think.
  • List such as the below need to be converted to a 3 column table:
- Content-Type := not applicable
- Accept := `application/json` by default, or `application/x-msgpack`, `text/html`
- Auth required := yes ([basic](#basic-authentication) or [token](#token-authentication))

I think this may need to be looked at with your other PR too.

ahhh you beat ne to it ...I was going to re-tag you for review when I was done properly :). But thanks for your input as always :)

@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2113-conv-jgqqz4 October 24, 2025 13:34 Inactive
@franrob-projects franrob-projects force-pushed the EDU-2113-convert-rest-api-to-mdx branch from eb3435a to 8ec0401 Compare October 24, 2025 13:35
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2113-conv-jgqqz4 October 24, 2025 13:35 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

3 participants