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

UV-5 - Enhance docs #6

Merged
merged 13 commits into from
Oct 9, 2024
Merged

UV-5 - Enhance docs #6

merged 13 commits into from
Oct 9, 2024

Conversation

JeffMboya
Copy link
Contributor

What type of PR is this?

This is a documentation update

What does this do?

This PR enhances the clarity of the documentation

Which issue(s) does this PR fix/relate to?

Have you included tests for your changes?

No

Did you document any new/modified features?

No

Notes

@JeffMboya JeffMboya marked this pull request as ready for review October 8, 2024 18:52
docs/developer-guide.md Outdated Show resolved Hide resolved
docs/developer-guide.md Outdated Show resolved Hide resolved
docs/developer-guide.md Outdated Show resolved Hide resolved
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
docs/developer-guide.md Outdated Show resolved Hide resolved
docs/developer-guide.md Outdated Show resolved Hide resolved
docs/developer-guide.md Outdated Show resolved Hide resolved
docs/developer-guide.md Outdated Show resolved Hide resolved
docs/developer-guide.md Outdated Show resolved Hide resolved
Signed-off-by: JeffMboya <[email protected]>
Copy link
Contributor

@rodneyosodo rodneyosodo left a comment

Choose a reason for hiding this comment

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

LGTM

Before logging in or interacting with Cube AI, you need to make sure that Cube AI has been deployed and is running. Deployment can be done by the instance administrator or by you if you have the necessary access permissions. Therefore, to Connect:

1. Ensure that Cube AI is deployed and running on your instance.
2. Connect to the deployed Cube AI instance on port `6193` using your login credentials (username and password).
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you explain why this port comes from? If this is Oolama specific, then mention this. If this is ours then explain that it is user-definable through ENV and that this is just a default.


1. Ensure that Cube AI is deployed and running on your instance.
2. Connect to the deployed Cube AI instance on port `6193` using your login credentials (username and password).
3. If you are unable to log in, contact the administrator of the instance and request that they create a new user account for you.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove this, not needed for the doc

Copy link
Contributor

@drasko drasko left a comment

Choose a reason for hiding this comment

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

LGTM

@drasko drasko merged commit a1c345b into ultravioletrs:main Oct 9, 2024
1 check passed
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.

Feature: Enhance docs
3 participants