Skip to content

Fix broken docs links in README#87

Open
lrossillon-gladia wants to merge 1 commit into
mainfrom
fix-readme-links
Open

Fix broken docs links in README#87
lrossillon-gladia wants to merge 1 commit into
mainfrom
fix-readme-links

Conversation

@lrossillon-gladia
Copy link
Copy Markdown

@lrossillon-gladia lrossillon-gladia commented Feb 10, 2026

Summary by CodeRabbit

  • Documentation
    • Updated documentation links to point to the latest API reference and getting started guides, ensuring users are directed to current resources.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 10, 2026

📝 Walkthrough

Walkthrough

Updated 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

Cohort / File(s) Summary
Documentation Link Updates
README.md
Updated three documentation links: replaced docs.gladia.io/reference/ paths with docs.gladia.io/api-reference/...-flow for transcription references, and updated introduction link to point to docs.gladia.io/chapters/introduction/getting-started.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Links hop to their new home with glee,
docs flow seamlessly, one, two, three,
No logic bent, just pathways rearranged,
The garden of knowledge, refreshed and changed! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Fix broken docs links in README' accurately describes the main change: updating documentation links in the README file from outdated paths to correct ones.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-readme-links

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.

Comment thread README.md Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Broken as well

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

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.

Comment thread README.md
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)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants