-
Notifications
You must be signed in to change notification settings - Fork 8
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
Improve Streamlit landing page #76
Conversation
filled out document similarity section
added picture
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.
I haven't really gotten the chance to read into the details. Most are great, just one comment below. Another thing, can you create a folder named docs
, and just put this markdown file in there. It seems like there will be more documentation coming up soon, so I would like to have them all in one place. Thanks!
Add clarification of file limits for spacy
I think that your PR has multiple issues resulting from this commit 7b74560 . This reverts very important fixes. Please make sure to resolve this by restoring the deleted files and re-adding the important fixes |
…al-CS/GatorMiner into issue#60"" This reverts commit 7b74560.
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.
I think the new landing page looks great! I requested few small changes that you should address before merging this PR. Thanks for working on this helpful documentation!
Codecov Report
@@ Coverage Diff @@
## master #76 +/- ##
=======================================
Coverage 91.07% 91.07%
=======================================
Files 6 6
Lines 224 224
=======================================
Hits 204 204
Misses 20 20 |
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.
Hi @nathandloria, I think this PR is good! I have just added an mdl
check into the Travis CI, so it would enforce markdown rules on documents in docs
folder. Should anything fail (there is probably not, but just in case), just do a quick fix, I don't think it would be anything substantial. Thanks again!
In this pull request we created a new landing page to reduce redundancy generated by the README. The new landing page is in markdown format and it displays a lot of helpful information about the tool. It also shows quick instructions further explaining how to use the tools provided by GatorMiner.
What is the current behavior?
closes #60
What is the new behavior if this PR is merged?
New, less redundant landing page.
Please describe the pull request as one of the following:
Other information
This PR has:
Developers
@PaigeCD @caldwella2 @angusn8 @connellyw @nathandloria