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

docs: Fixed README link & update documentation #774

Merged
merged 3 commits into from
Dec 31, 2021
Merged

docs: Fixed README link & update documentation #774

merged 3 commits into from
Dec 31, 2021

Conversation

fg-mindee
Copy link
Contributor

This PR introduces the following modifications:

  • fixed the hyperlinks to the documentation in the README
  • adds the new datasets to the list on the documentation landing page
  • fixed the version display on the documentation: when accessing a subtag of a page, the URL included a part .html#mytag and the parser was failing to show the correct part. This is now fixed

Any feedback is welcome!

@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation type: enhancement Improvement labels Dec 30, 2021
@fg-mindee fg-mindee added this to the 0.5.0 milestone Dec 30, 2021
@fg-mindee fg-mindee self-assigned this Dec 30, 2021
@codecov
Copy link

codecov bot commented Dec 30, 2021

Codecov Report

Merging #774 (388331c) into main (0b15ad1) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #774   +/-   ##
=======================================
  Coverage   95.95%   95.95%           
=======================================
  Files         130      130           
  Lines        4866     4866           
=======================================
  Hits         4669     4669           
  Misses        197      197           
Flag Coverage Δ
unittests 95.95% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0b15ad1...388331c. Read the comment docs.

Copy link
Collaborator

@charlesmindee charlesmindee left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

@fg-mindee fg-mindee added the ext: docs Related to docs folder label Dec 31, 2021
@fg-mindee fg-mindee merged commit d3134e0 into main Dec 31, 2021
@fg-mindee fg-mindee deleted the doc-prep branch December 31, 2021 15:48
@fg-mindee fg-mindee added type: bug Something isn't working and removed type: enhancement Improvement labels Dec 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ext: docs Related to docs folder topic: documentation Improvements or additions to documentation type: bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants