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 features.sh #108

Closed
wants to merge 3 commits into from
Closed

Conversation

Vaibhav-Magadum
Copy link
Contributor

@Vaibhav-Magadum Vaibhav-Magadum commented Jul 16, 2024

#98 Updated the features to make it easy to understand for new users.

Summary by CodeRabbit

  • Documentation

    • Updated descriptions and terminology to enhance clarity regarding the features of Open Voice OS, specifically differentiating between the GUI and skills.
    • Refined localization strings in Hindi for better semantic understanding and user experience.
  • Style

    • Standardized terminology by updating "OVOS skills" to "Open Voice OS skills" for consistency across language settings.

@goldyfruit
Copy link
Member

@Vaibhav-Magadum Thanks for the PR. Could you please update as well all the other languages?

@goldyfruit goldyfruit added the enhancement New feature or request label Jul 18, 2024
Copy link
Contributor

coderabbitai bot commented Jul 18, 2024

Walkthrough

The updates to the features.sh files enhance clarity in descriptions related to the graphical user interface (GUI) and skills in Open Voice OS. By refining terminology, the changes better delineate the roles of these components, improving user understanding and experience. Users can now more easily appreciate the essential skills and optional features available, promoting informed interaction choices.

Changes

File Change Summary
tui/locales/en-us/features.sh Updated descriptions for GUI and skills to enhance clarity and specificity.
tui/locales/hi-in/features.sh Improved Hindi descriptions for features, enhancing semantic clarity.

Poem

In the code garden, changes bloom,
GUI shines bright, dispelling gloom.
Skills refined, with meanings clear,
Open Voice OS, we hold so dear.
With each update, our joy takes flight,
A world of wonder, oh what a sight!
🐇✨🎶


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@goldyfruit goldyfruit added this to the Descent milestone Jul 18, 2024
Copy link
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 770d161 and 5b1fca1.

Files selected for processing (1)
  • tui/locales/en-us/features.sh (1 hunks)
Additional comments not posted (5)
tui/locales/en-us/features.sh (5)

4-4: LGTM!

The context provided for choosing between enabling the GUI and loading skills is clear and enhances user understanding.


6-6: LGTM!

The description of the GUI as an additional visual layer for easier interaction is clear and accurate.


8-8: LGTM!

The description of skills as enabling interaction through speech for various tasks is clear and accurate.


13-13: LGTM!

The update from "OVOS" to "Open Voice OS" in the description of loading default skills improves clarity.


14-14: LGTM!

The update from "OVOS" to "Open Voice OS" in the description of loading extra skills improves clarity.

@Vaibhav-Magadum
Copy link
Contributor Author

@goldyfruit sure I would update.Can I add the link of documentation to point on what "extra skills" are..!?

@goldyfruit
Copy link
Member

Links are hard to manage via TUI.

@tobymurray
Copy link
Contributor

I didn't mean to bog this PR down with the baggage of defining what extra skills are. I was looking at the same screen and thought it'd be appropriate "while we're in there". Just wanted to call out as a new user it's pretty meaningless - I have no intuition what enabling "extra skills" is intended to do or what I miss out on by keeping it disabled.

@JarbasAl
Copy link
Member

perhaps "essential" skills would help understanding the difference, "extras" is just more official OVOS skills but that are not critical and it's fine if missing

@Vaibhav-Magadum
Copy link
Contributor Author

Ok....now what are the final changes to be done..!?

@JarbasAl
Copy link
Member

SKILL_DESCRIPTION="Load essential Open Voice OS skills"

I would propose just this change, instead of default, that gives a better picture of what extra skills are

@JarbasAl
Copy link
Member

JarbasAl commented Jul 19, 2024

maybe also rename extra to optional?

EXTRA_SKILL_DESCRIPTION="Load optional Open Voice OS skills"

@tobymurray would this sound better and help clearing confusion?

further explanations should be added in separate documentation, in general i think we need a Getting Started guide that covers this sort of stuff in more depth. @goldyfruit maybe a note and url can be added in the tutorial you wrote

@tobymurray
Copy link
Contributor

I don't want to hold up this PR, everything seems like an improvement.

@goldyfruit @tobymurray would this sound better and help clearing confusion?

Honestly - no. If they're "essential" it's not clear as a user why I would be deselecting them ever and "extra"/"additional" etc. is meaningless without exposure to the ecosystem enough to intuitively understand what that would encompass. I imagine it's hard to go back to not knowing what this stuff refers to, but if I were to sell you a car and say "for 1000$ more I'll throw in some extras" I think most people's first question would be "... well, what are the extras?"

If we can't explain what these skill are broadly, then I think the second best option would be to suggest why one would choose them. What is the use case for a user not selecting the default OVOS skills? Is this like Raspbian-full vs. Rasbian-lite? Riffing on that, could go more in the direction of e.g. (just making things up):

SKILL_DESCRIPTION="Load essential Open Voice OS skills for basic functionality"
EXTRA_SKILL_DESCRIPTION="Load comprehensive Open Voice OS skill set for a broader experience"

Thoughts:

  • does it make sense to prompt for the "default" at all? Are these "required" to have a basic working installation from the perspective of OVOS's offerings, or are these a curated list of the most production ready skills? As a point of reference, phones don't prompt whether the user would like a calculator installed or not, allowing a user to uninstall is seen as a better experience.
  • does disabling the default but enabling extra support an actual use case?

further explanations should be added in separate documentation, in general i think we need a Getting Started guide that covers this sort of stuff in more depth

Definitely that seems like a worthwhile resource.

@JarbasAl
Copy link
Member

JarbasAl commented Jul 19, 2024

does it make sense to prompt for the "default" at all? Are these "required" to have a basic working installation from the perspective of OVOS's offerings, or are these a curated list of the most production ready skills? As a point of reference, phones don't prompt whether the user would like a calculator installed or not, allowing a user to uninstall is seen as a better experience.

this question is very valid and has a lot of nuances

if you think about arch linux where a user makes their OS from scratch, this would be the equivalent of installing OVOS with no skills, as a power user you would curate exactly which skills you want.

Besides this sort of power user, this also allows downstream to automate the install and use their own skills better suited for their use case.

So the answer to "are these required" is no... but the answer to "does it make sense to prompt for the default at all?" is more complex.

If we want to specifically target new users as the main audience, maybe we should not prompt about default skills at all, but if the goal is for the installer to be flexible for more use cases then it should remain as an option.

In the case of automated installs usually there is no prompting, it's a config file, so perhaps we can just omit the option from the TUI but still support it?

I'm sure we can find something in between, let's open an issue to continue the discussion there

does disabling the default but enabling extra support an actual use case?

not really, technically valid but i don't see why someone would do that in practice

@goldyfruit
Copy link
Member

@tobymurray please open a PR with your changes and I will review them. 👍

@goldyfruit
Copy link
Member

@Vaibhav-Magadum are you still working on this PR?

@Vaibhav-Magadum
Copy link
Contributor Author

@goldyfruit I have examination going in my college so I would get back once they get over....!!!

@goldyfruit
Copy link
Member

@goldyfruit I have examination going in my college so I would get back once they get over....!!!

Ohhhhh take all the time you need, no rush and school first!

Good luck! 🤞 🍀

Copy link
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5b1fca1 and 4e9c511.

Files selected for processing (2)
  • tui/locales/en-us/features.sh (1 hunks)
  • tui/locales/hi-in/features.sh (1 hunks)
Files skipped from review due to trivial changes (1)
  • tui/locales/hi-in/features.sh
Additional comments not posted (3)
tui/locales/en-us/features.sh (3)

4-4: Improved clarity in user instructions.

The updated description helps users better understand the difference between enabling the GUI and loading skills.


6-6: Enhanced description of the GUI.

The updated description clarifies the role of the GUI as an additional visual layer for easier interaction.


13-14: Clearer descriptions for essential and extra skills.

The updated descriptions provide better clarity on the role of essential and extra skills, aiding user understanding.

@Vaibhav-Magadum
Copy link
Contributor Author

@goldyfruit @JarbasAl @tobymurray I have Update the PR.....!!
Inform if any other changes required.

GUI_DESCRIPTION="ग्राफिकल यूजर इंटरफेस (GUI) इस्तमाल करें"
TITLE="ओपन वॉयस ओएस इंस्टालेशन - विशेषताएं"
SKILL_DESCRIPTION="बुनियादी कार्यक्षमता के लिए आवश्यक ओपन वॉयस ओएस कौशल लोड करें"
EXTRA_SKILL_DESCRIPTION="व्यापक अनुभव के लिए अतिरिक्त ओपन वॉयस ओएस कौशल (वैकल्पिक) सेट लोड करें"
Copy link
Contributor

@suvanbanerjee suvanbanerjee Aug 1, 2024

Choose a reason for hiding this comment

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

बेहतर अनुभव के लिए अतिरिक्त ओपन वॉयस ओएस कौशल (वैकल्पिक) सेट लोड करें।

This is more easy to understand

SKILL_DESCRIPTION="डिफ़ॉल्ट OVOS कौशल लोड करें"
EXTRA_SKILL_DESCRIPTION="अतिरिक्त OVOS कौशल लोड करें"
GUI_DESCRIPTION="ग्राफिकल यूजर इंटरफेस (GUI) इस्तमाल करें"
TITLE="ओपन वॉयस ओएस इंस्टालेशन - विशेषताएं"
Copy link
Contributor

Choose a reason for hiding this comment

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

it should be विशेषताएँ not विशेषताएं

@goldyfruit
Copy link
Member

@goldyfruit @JarbasAl @tobymurray I have Update the PR.....!! Inform if any other changes required.

All of them I guess. Feel free to use Deepl to translate some parts.

@Vaibhav-Magadum
Copy link
Contributor Author

@goldyfruit deeply doesn't support Hindi language...I will look for another alternative..!!

An changes necessary in English part .!?

@goldyfruit
Copy link
Member

@Vaibhav-Magadum English version looks good to me.

@goldyfruit goldyfruit modified the milestones: Descent, Wolfenstein Sep 10, 2024
@goldyfruit goldyfruit marked this pull request as draft September 19, 2024 21:35
@goldyfruit
Copy link
Member

Closing due to #161

@goldyfruit goldyfruit closed this Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants