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

More examples and screenshots in docs #76

Open
1 of 6 tasks
alanJames00 opened this issue Jul 28, 2023 · 12 comments
Open
1 of 6 tasks

More examples and screenshots in docs #76

alanJames00 opened this issue Jul 28, 2023 · 12 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest Hacktoberfest

Comments

@alanJames00
Copy link

Issue Title

Type

  • Big
  • Feature Request
  • Info
  • Bug
  • Documentation
  • Other (please specify):

Description

The docs are missing some examples and use cases along with related screenshots on how to use the tool.

Expected Behavior

Current Behavior

Steps to Reproduce

Screenshots / Code Snippets (if applicable)

Environment

  • Operating System:
  • Browser (if applicable):
  • Version/Commit ID (if applicable):

Possible Solution (if you have any in mind)

I am happy to write some examples and take screenshots. Please consider assigning this issue to me.

Additional Information

@srbhr
Copy link
Owner

srbhr commented Jul 29, 2023

Thanks @alanJames00 I will look into it, and will see how we can improve and add better docs.

@srbhr srbhr added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Jul 29, 2023
@alanJames00
Copy link
Author

@srbhr Would you consider some of contributions for it?

@srbhr
Copy link
Owner

srbhr commented Jul 29, 2023

@alanJames00 yes please if you would add some, it would be great!

@shravan20
Copy link
Contributor

@srbhr: Can i pick this up?

@srbhr srbhr added the hacktoberfest Hacktoberfest label Sep 25, 2023
@israelram
Copy link

Hello, I would love to be able to take on this task or any task that you assign to me, please tell me and I would be happy to contribute.

@srbhr
Copy link
Owner

srbhr commented Sep 26, 2023

Hi @israelram you can contribute to this issue. Maybe can you come up with an interactive blog on how to install this with images?

@israelram
Copy link

Hi @israelram you can contribute to this issue. Maybe can you come up with an interactive blog on how to install this with images?

sorry you have more info about the issue or something that i miss

@omzi
Copy link

omzi commented Oct 9, 2023

Hi @srbhr! Could you assign this issue to me?

@srbhr
Copy link
Owner

srbhr commented Oct 9, 2023

@omzi do you know where the docs are ?

@omzi
Copy link

omzi commented Oct 9, 2023

Yes I do. It's on a separate repo. It seems someone has beat me to it and made a PR ;).

@5enox
Copy link

5enox commented Oct 23, 2023

Hey everyone, it seems you're ahead of the game! If you're working on this, here's a resource that might come in handy: Here. Happy coding!

@smart-patrol
Copy link

+1 on more docs. From the a user perspective I am not sure how to use.

Right now the entities between the docs are unlinked so it seems like it would be a comparison between the top words in each and then making sure that the user resume has overlap? Documentation with example usage for ASR would be helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest Hacktoberfest
Projects
None yet
Development

No branches or pull requests

7 participants