Skip to content

Fix broken docs links in README #87

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.

Sign up for GitHub

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

Open
lrossillon-gladia wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix broken docs links in README #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ This repo contains Gladia samples for several languages. Feel free to do a PR to

All languages aim to have 2 minimalist examples:

- [Pre-recorded](https://docs.gladia.io/reference/pre-recorded) (You have an audio file that you'd like to transcribe)
- [Live transcription](https://docs.gladia.io/reference/live-audio) (You'd like to have a live transcription of a file/audio stream)
- [Pre-recorded](https://docs.gladia.io/api-reference/pre-recorded-flow) (You have an audio file that you'd like to transcribe)
- [Live transcription](https://docs.gladia.io/api-reference/live-flow) (You'd like to have a live transcription of a file/audio stream)

All examples are using the `audio/text/audio-transcription` endpoint, but you can change this to `video/text/video-transcription` endpoint if you are using videos.
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)

@coderabbitai coderabbitai Bot Feb 10, 2026

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.


## Available Samples Status

Expand All @@ -22,7 +22,7 @@ You can still check the full documentation [here](https://docs.gladia.io/referen

## Something is missing? Contact us!

You can contact us directly [here](https://gladiaio.typeform.com/support?typeform-source=github.com/gladiaio/gladia-samples) and you can also open an issue in this repository.
You can contact us directly [here](https://gladia.support.site) and you can also open an issue in this repository.

## Git LFS

Expand Down