Skip to content
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.

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

Update docs #1701

Merged
merged 6 commits into from
Apr 8, 2025
Merged

Update docs #1701

merged 6 commits into from
Apr 8, 2025

Conversation

viren-nadkarni
Copy link
Member

@viren-nadkarni viren-nadkarni commented Mar 21, 2025

This PR updates docs for some services by fixing inaccurate information and rephrasing certain other stuff.

@viren-nadkarni viren-nadkarni self-assigned this Mar 21, 2025
Copy link

github-actions bot commented Mar 21, 2025

Deploy PR Preview failed.

@viren-nadkarni viren-nadkarni changed the title Refine docs Update docs Mar 26, 2025
@viren-nadkarni viren-nadkarni marked this pull request as ready for review April 3, 2025 08:09
Copy link
Contributor

@sannya-singal sannya-singal left a comment

Choose a reason for hiding this comment

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

Thanks for tackling this 🚀 I just have one question, transcribe changes LGTM 👍

Comment on lines 17 to 20
LocalStack Transcribe uses an offline speech-to-text library called [Vosk](https://alphacephei.com/vosk/).
It requires an active internet connection to download the language model.
Once the language model is downloaed, subsequent transcriptions for the same language can be performed offline.
Language models typically have a size of around 50 MiB and are saved in the cache directory (see [Filesystem Layout]({{< ref "filesystem" >}})).
Copy link
Contributor

Choose a reason for hiding this comment

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

ques: is there any specific reason we remove the callout preview from this information?

Copy link
Member Author

Choose a reason for hiding this comment

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

I admit we don't have concrete guidelines for its use yet, but I think callouts should be used for short, easy-to-digest information that needs to stand out. This specific box felt like it was too big to be a callout and instead would fit in better if it were part of the standard flow.

Before

image

Now

image

Copy link
Member

@HarshCasper HarshCasper left a comment

Choose a reason for hiding this comment

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

Please do not change the Current Limitations heading, since this is a standard we follow all across the docs.

@viren-nadkarni viren-nadkarni merged commit 92e4b59 into main Apr 8, 2025
5 checks passed
@viren-nadkarni viren-nadkarni deleted the assorted branch April 8, 2025 11:17
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.

4 participants