-
Notifications
You must be signed in to change notification settings - Fork 52
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
Modify Trapheus readme to include TrapheusAI #180
Conversation
README.md
Outdated
|
||
* **Important:** this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the [AWS pricing page](https://aws.amazon.com/pricing/) for details. | ||
👉 [View Trapheus Documentation](\docs\README.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of View Trapheus Documentation
, can it be Trapheus Docs
same for TrapheusAI
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of
View Trapheus Documentation
, can it beTrapheus Docs
same for TrapheusAI
Okay, will modify this. Also would like to go ahead and add the 'Prepare your environment' section present in Trapheus readme in the main readme? As I feel individuals should not really need to visit either documentation to get started with Trapheus code base?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Both the repositories will have different way fo installation. I feel we can provide some content in terms of "what" Trapheus solves for in the world of data and then we can link them to their respective docs. Let me know if you think it would be meaningful?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Have made the minor fix. Feel free to review this. I think some context of what each of them does has already been provided. If you'd like me to add something specific please let me know.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @yash-1o1 I will review this today and possibly modify this a bit
This pull request has been marked as stale because it has been inactive for more than 14 days. Please update this pull request or it will be automatically closed in 7 days. |
Description
Made changes to the readme.md files and fixed the path to the individual unit test.
Would like to go ahead and add the 'Prepare your environment' section present in Trapheus readme in the main readme. Please let me know if this is something that's needed.
Relevant Issue
Relevant PRs (optional): N/A
Type of change