Add description and other examples #29
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zgreathouse
reviewed
Apr 30, 2024
| | [`evi-typescript-example`](/evi-typescript-example/README.md) | Typescript | Vanilla JS | | | ||
| | [`evi-custom-language-model`](/evi-custom-language-model/README.md) | Python | | | | ||
| | [`meld`](/meld/README.md) | Typescript | React | | | ||
| | [`next-app`](https://github.com/HumeAI/empathic-voice-api-js/tree/main/examples/next-app) | Typescript | Next.js | | |
There was a problem hiding this comment.
@jerhadf
These are shell apps within the empathic-voice-api-js monorepo. (The purpose of these shell apps are to test packages published from the monorepo locally)
There is some work to be done to make these into example apps which serve as external developer resources:
- Update project names to reflect what they are an example of.
- Update project READMEs to include: descriptions of what the apps are and what they do, env setup instructions, instructions to build/run the projects, and instructions for usage.
- Comments throughout the code which act as documentation for the code, explaining various steps is also really good to have— but can be added later based on developer feedback (like when something is called out as unclear)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.