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

Add current docs link to README #582

Merged
merged 3 commits into from
Jan 8, 2024
Merged

Conversation

seabbs
Copy link
Contributor

@seabbs seabbs commented Jan 5, 2024

Description

In #563 @sbfnk introduced new functionality to post users at the alternative version of the docs to the one they are currently viewing. However, if they are not on the HTML docs then there is currently no link to the current version of the HTML docs that they are looking at. It could be nice if this were the case.

This PR adds this. I think worth some discussion to check it makes sense .

Checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have included the target issue or issues in the PR title as follows: issue-number: PR title
  • I have tested my changes locally.
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required.
  • I have built the package locally and run rebuilt docs using roxygen2.
  • My code follows the established coding standards and I have run lintr::lint_package() to check for style issues introduced by my changes.
  • I have added a news item linked to this PR.
  • I have reviewed CI checks for this PR and addressed them as far as I am able.

@seabbs seabbs requested review from sbfnk and nikosbosse January 5, 2024 17:11
Copy link

codecov bot commented Jan 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (61905cf) 85.15% compared to head (121331d) 85.15%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #582   +/-   ##
=======================================
  Coverage   85.15%   85.15%           
=======================================
  Files          21       21           
  Lines        1711     1711           
=======================================
  Hits         1457     1457           
  Misses        254      254           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Base automatically changed from develop to main January 5, 2024 17:34
Copy link
Contributor

@nikosbosse nikosbosse left a comment

Choose a reason for hiding this comment

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

Good idea, I like this. Thank you!

@nikosbosse nikosbosse merged commit 40b5f0d into main Jan 8, 2024
11 checks passed
@nikosbosse nikosbosse deleted the add-current-docs-list-to-readme branch January 8, 2024 11:35
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