Improve flow of install page #274
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
|
It looks like the pr-milestone-check is causing the CircleCI redirector action to be skipped. In any case, this looks good to me, thanks @dstansby ! |
melissawm
approved these changes
Nov 20, 2023
|
The whole CircleCI job isn't proc'ing... |
psobolewskiPhD
approved these changes
Nov 20, 2023
There was a problem hiding this comment.
I can't make the suggestion, but what are y'alls thoughts on using tab sets instead of the admonitions? (new line 58)
Like here:
https://napari.org/dev/developers/contributing.html#setting-up-a-development-installation
Code:
https://github.com/napari/docs/blob/1a3192fd7fc549b4ef8730dccae8bcbc673096c9/docs/developers/contributing.md?plain=1#L31C5-L54
|
Love the tabs, maybe in a follow-up? |
melissawm
pushed a commit
to melissawm/napari-docs
that referenced
this pull request
Dec 1, 2023
# Description Update installation guide: - If I'm installing the bundled app, I don't care about pre-requisites for installing the Python package, so move that section under the "Installing as a Pytho package" section - Modify the header levels, so the second level now only has "Install as Python package", "Install as bundled app", "Next steps". In particular, two sections which are only relevant to the Python package route have been moved down a level to simplify the top level contents. Co-authored-by: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
jni
pushed a commit
that referenced
this pull request
Jan 9, 2024
# References and relevant issues This came up at the docs workgroup and also: #274 (review) # Description Currently, the install docs have pip, conda and GitHub install instructions in series followed by the `checking that it worked`. No-one will use all three approaches. In this PR instead Tabs are used for *each* of the approaches, to let the user choose an install strategy. This makes the install page simpler and cleaner, leading the user to the the next logical step. What it looks like: <img width="776" alt="image" src="https://github.com/napari/docs/assets/76622105/3c86bb63-07e0-44e9-83c5-6e777698f2db">
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description