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

documentation tiny thing - self link #41

Closed
jayoung opened this issue Jun 12, 2024 · 1 comment
Closed

documentation tiny thing - self link #41

jayoung opened this issue Jun 12, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation low priority Not urgent or critical, implement whenever v1.1 Should be implemented in PROOF v1.1

Comments

@jayoung
Copy link

jayoung commented Jun 12, 2024

hi,

apologies if I start bombarding you with small things (a few months ago you asked for feedback) - you can tell me stop if it's annoying.

on this page: https://getwilds.org/rcromwell/

it's confusing that the link embedded here:

Go to http://getwilds.org/rcromwell/ for rcromwell package documentation.

is pointing towards the same page we're already on.

would be great instead to link out to the "Get Started vignette" - https://getwilds.org/rcromwell/articles/rcromwell.html

or even better provide a bullet point list with links to the two docs I can see listed in the top header bar thing: Get Started, and Reference

thanks,

Janet

@tefirman
Copy link
Member

@jayoung -- not annoying at all, thanks for taking a look! You're totally right, it's kind of self-defeating to point to the page you're already on, we should probably repurpose that text to describe what is contained in each section. Thanks for catching that!

@tefirman tefirman added documentation Improvements or additions to documentation low priority Not urgent or critical, implement whenever v1.1 Should be implemented in PROOF v1.1 labels Jul 30, 2024
@tefirman tefirman added this to the PROOF v1.1 milestone Jul 30, 2024
@sckott sckott modified the milestones: PROOF v1.1, rcromwell v3.2.4 Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation low priority Not urgent or critical, implement whenever v1.1 Should be implemented in PROOF v1.1
Projects
None yet
Development

No branches or pull requests

3 participants