Fix broken docs links in README#87
Conversation
📝 WalkthroughWalkthroughUpdated documentation links in README.md to reflect changes in the documentation site structure. Pre-recorded and live transcription references now point to the new API reference flow endpoints, and the introduction link targets the updated getting-started documentation page. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Line 13: Replace the non-descriptive link text "[here]" in the sentence "You
can still check the full documentation
[here](https://docs.gladia.io/chapters/introduction/getting-started)" with
descriptive link text that conveys the destination (for example "full Gladia
documentation" or "Getting Started guide"); update the markdown so the link
reads like "You can still check the full documentation: [Getting Started
guide](https://docs.gladia.io/chapters/introduction/getting-started)" to improve
accessibility and clarity.
| Keep in mind that parameters are `video` and `video_url` instead of `audio` and `audio_url` if you want to use `video/text/video-transcription` endpoint. | ||
|
|
||
| You can still check the full documentation [here](https://docs.gladia.io/reference/introduction) | ||
| You can still check the full documentation [here](https://docs.gladia.io/chapters/introduction/getting-started) |
There was a problem hiding this comment.
Use descriptive link text instead of “here.”
Improves readability and accessibility.
✅ Suggested edit
-You can still check the full documentation [here](https://docs.gladia.io/chapters/introduction/getting-started)
+You can still check the full documentation in the [Getting started guide](https://docs.gladia.io/chapters/introduction/getting-started)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| You can still check the full documentation [here](https://docs.gladia.io/chapters/introduction/getting-started) | |
| You can still check the full documentation in the [Getting started guide](https://docs.gladia.io/chapters/introduction/getting-started) |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 13-13: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
In `@README.md` at line 13, Replace the non-descriptive link text "[here]" in the
sentence "You can still check the full documentation
[here](https://docs.gladia.io/chapters/introduction/getting-started)" with
descriptive link text that conveys the destination (for example "full Gladia
documentation" or "Getting Started guide"); update the markdown so the link
reads like "You can still check the full documentation: [Getting Started
guide](https://docs.gladia.io/chapters/introduction/getting-started)" to improve
accessibility and clarity.
6e8a970 to
126a8fc
Compare
Summary by CodeRabbit