docs: restructure README around Diátaxis modes#7
Open
trevormunoz wants to merge 1 commit into
Open
Conversation
Reorganize the README so its modes stay unmixed and the getting-started path actually works end to end: * Add an About section (what the repo is, who it's for, the live site). * Add a Prerequisites section that lists Hugo (extended) and go-task — the previous README omitted Hugo, so a fresh clone running 'task serve' hit 'hugo: command not found'. * Correct the Homebrew formula (task -> go-task) and combine installs. * Frame the Python setup as the data/API-user path and link the code examples and TEST_PYTHON_EXAMPLES.md. * Add a thin project-structure table. * Add Contributing (markdownlint conventions) and License (Apache-2.0) sections.
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
Good news. The first-run setup basically "just works". This PR is mostly suggestions to make it a bit friendlier.
Why
The README's setup steps only tell you to install
task, buttask serveshells out to
hugo server, so if you don't already havehugoyou hithugo: command not found. The README also could point to other docs that arealready present to offer some more orientation for the first-time reader.
Changes
live site (https://opendata.lib.umd.edu/).
Hextra theme) alongside go-task. This is the fix for the missing-Hugo
failure above.
task serve→http://localhost:1314/), plus
task build/task clean.brew install task→brew install hugo go-task.scripts and
TEST_PYTHON_EXAMPLES.md.Verification
npx markdownlint-cli README.mdpasses clean.(Hugo 0.164.0 extended, go-task 3.52.0): 41 pages built, site served and
returned HTTP 200 at localhost:1314.