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

Documentation improvements #60

Merged
merged 4 commits into from
Dec 20, 2024
Merged

Documentation improvements #60

merged 4 commits into from
Dec 20, 2024

Conversation

GFJHogue
Copy link
Collaborator

This PR aims to refactor the README to reflect the latest setup steps and essential introductory information for developers.

Markdown (.md) files can be previewed in the "Files Changed" tab of this PR by clicking the 📄 button towards the top-right of the diff (between <> and Viewed).

Please feel free to add your suggestions / comments.

@GFJHogue GFJHogue self-assigned this Dec 20, 2024
README.md Outdated
```
4. Install your chosen embeddings:
```bash
docker run --env-file .env -v $(pwd)/embeddings:/app/embeddings/ reactome-chatbot /bin/bash -c "./bin/embeddings_manager install openai/text-embedding-3-large/reactome/ReleaseXX"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@adamjohnwright do we want to replace these with docker compose commands?

Copy link
Contributor

Choose a reason for hiding this comment

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

yes

README.md Outdated
```
4. Install your chosen embeddings:
```bash
docker run --env-file .env -v $(pwd)/embeddings:/app/embeddings/ reactome-chatbot /bin/bash -c "./bin/embeddings_manager install openai/text-embedding-3-large/reactome/ReleaseXX"
Copy link
Contributor

Choose a reason for hiding this comment

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

yes

@GFJHogue GFJHogue merged commit 57917be into main Dec 20, 2024
7 checks passed
@GFJHogue GFJHogue deleted the docs-revamp branch December 20, 2024 17:04
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.

2 participants