docs: link the download/install path from the guide - #11
Merged
Conversation
Stranger-read finding: both the guide home and the tutorial's 'Before you start' told readers they need MacDirStat installed but never linked to where to get it. A reader landing on /guide/ directly had no path to the download. Link the project page from both places.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
Adds download/install links to the docs guide: one on the guide home, one in the tutorial's Before you start.
Why
Week 6 'empathy for the reader' exercise (read the docs as a stranger): both pages say you need MacDirStat installed, but neither links to where to get it. A reader who lands on
/guide/directly (search, shared link) hits a dead end at step zero. The landing page has the download button, so the fix is just linking it.How
guide/index.md: 'Not installed yet?' paragraph pointing at the project page and the build-from-source path.guide/tutorial/first-scan.md: install link in Before you start.Test
mkdocs build --strictpasses locally; links point at the existing landing page.