Use new RTD dashboard #1472
Use new RTD dashboard #1472
Conversation
rhornung67
requested review from
white238,
cyrush,
BradWhitlock,
kennyweiss,
nselliott,
publixsubfan,
gunney1,
bmhan12 and
Arlie-Capps
README.md
Outdated
|
|
||
| To access docs for other versions: https://readthedocs.org/projects/axom/ | ||
| To access the latest docs for Axom as well as those for specific versions: | ||
| https://app.readthedocs.org/projects/axom/ |
There was a problem hiding this comment.
I am not sure this is a helpful link for users.
https://axom.readthedocs.io/en/develop/
that is what i would expect to see. Otherwise they have to know to click the little book icon.
There was a problem hiding this comment.
@white238 I twiddled with the dashboard settings. I think this is what we want now.
README.md
Outdated
|
|
||
| To access docs for other versions: https://readthedocs.org/projects/axom/ | ||
| To access Axom docs for specific versions: https://app.readthedocs.org/projects/axom/ |
There was a problem hiding this comment.
I am not sure how much value the second link is giving us much. They have to know to click on the book icon not the word "develop". It really isn't a list of versions, it is more of a list of builds, which a user doesn't care about.
This is just my opinion for what little it's worth.
There was a problem hiding this comment.
I don't like the book icon either. But, if we don't have the second link, how does one get to a specific version?
There was a problem hiding this comment.
It's in the bottom right hand corner
There was a problem hiding this comment.
Ah. Is that clearer? It obviously wasn't for me.
There was a problem hiding this comment.
That "develop" button is handy. I didn't know about that.
|
Folks, I don't necessarily like the new RTD dashboard. If you have ideas about a better way to reference our docs on RTD, please suggest them here. Thank you. |
How about just removing the link and adding a comment in the readme for where to find it on the regular RTD page? Something like "For documentation versions other than develop, expand the sub-window on any RTD page." |
|
@white238 suggestion pushed. |
Summary