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

Minor documentation issues #27

Closed
schuemie opened this issue Jan 19, 2022 · 3 comments · Fixed by #29
Closed

Minor documentation issues #27

schuemie opened this issue Jan 19, 2022 · 3 comments · Fixed by #29

Comments

@schuemie
Copy link
Member

For a next release, it might be good to fix these:

  1. The documentation website still lists version 0.0.1.994 as the current version. Next time make sure to generate the website as one of the last steps (after updating the version number).
  2. The documentation website is missing the GitHub link in the top right corner (see the CohortMethod site as example. I must admit I'm not sure why that is. The _pkgdown.yml looks fine.
  3. The vignette titles are bit ugly, like 'Capr_Attributes_Extended', instead of perhaps 'Using extended cohort attributes in Capr', which would be both human-readable and more informative.
  4. The Documentation section in the README doesn't list all vignettes.
  5. The Installation section in the README mentions a checkCmInstallation() function that is not part of Capr.
@schuemie
Copy link
Member Author

Additionally:
6. The Github Action badge in the README currently links to https://github.com/OHDSI/<reponame>/actions?query=workflow%3AR-CMD-check, which is not a valid URL. I recommend replacing <reponame> with Capr.

@mdlavallee92
Copy link
Collaborator

Not sure why the github link is not working either. I used the template code of the other packages. I will keep looking at the files and see if I find something.

Other issues have been addressed and the package down site has been updated (forgot to update before the release).

This issue will close once I accept the pull request linked to these issues

mdlavallee92 added a commit that referenced this issue Jan 19, 2022
Address Issue #27 and #28 updating documentation and minor fixes
@schuemie
Copy link
Member Author

I found the issue with the missing GitHub link: the link to the GitHub site must be in the DESCRIPTION file. I took the liberty of pushing this fix to the develop branch.

Next time please remember to call fixHadesLogo after regenerating the website.

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 a pull request may close this issue.

2 participants