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

Init documentation #28

Merged
merged 17 commits into from
Nov 30, 2023
Merged

Init documentation #28

merged 17 commits into from
Nov 30, 2023

Conversation

rroutsong
Copy link
Collaborator

Documentation development and deployment. Renamed to weave. Docs deployed to https://openomics.github.io/weave/.

Addresses #26 #27

Copy link
Contributor

@skchronicles skchronicles left a comment

Choose a reason for hiding this comment

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

Everything looks great! I just have a few very minor comments but those can be addressed at a later date. Thank you for adding the documentation and adding cache functionality!

Copy link
Contributor

Choose a reason for hiding this comment

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

I would probably just delete this file and add a link/pointer to it in the README

Copy link
Contributor

Choose a reason for hiding this comment

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

I would move this file into the docs/ directory and rename it to requirements.txt, i.e:

mv doc_requirements.txt docs/requirements.txt

Copy link
Contributor

Choose a reason for hiding this comment

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

The references at the bottom have some formatting issues. Adding some trailing spaces after the closing </sup> should fix the issue.

@skchronicles skchronicles merged commit 25c8d61 into main Nov 30, 2023
@skchronicles skchronicles deleted the init_documentation branch February 1, 2024 21:50
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.

3 participants