Repository navigation
Docs polish: fix install.sh repo, add badges, quick-install and doc-site link - #2
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2 +/- ##
=======================================
Coverage 92.01% 92.01%
=======================================
Files 49 49
Lines 18129 18129
=======================================
Hits 16681 16681
Misses 1448 1448 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Pi code reviewFindingsMedium — README.md (~line 326): doc-site link is removed, not relocatedThe PR title/body state that a ## Documentation
-- [Doc Site](https://must.ai) — full guides, recipe reference, and migration docs
- [Architecture](docs/DESIGN.md) — execution model and internalsNet effect: the README loses its only link to the docs site, the opposite of the stated intent. Either re-add the link near the top as described or restore the bullet. Medium — README.md (line 4): license badge contradicts the PR descriptionThe PR body says the badge row includes an "MIT License badge," but the added badge is Apache 2.0: [](LICENSE)One of these is wrong. Verify the actual license and make the badge match; also confirm the badge's link target Low — README.md (Install section): Windows
|
- Use a fetch-then-run install form so a missing release fails visibly instead of curl|sh exiting 0 on empty stdin - Note the release prerequisite and that SHA256SUMS comes from the same channel (corruption guard, not tamper guard) - Warn clearly and skip when no sha256sum/shasum exists instead of aborting with an obscure not-found error under set -eu
|
Addressed the review:
The release-body hardcoding |
The domain predates this repo (upstream mustfile artifacts) and is not ours; in-repo docs under docs/ cover architecture and migration.
|
Correction to an earlier claim: I described adding "a prominent docs-site link near top" — that linked must.ai, which came in with upstream
Repointing these needs real values (your handle, a security email, or removal), so flagging rather than editing. |
|
License pieces settled: this branch's badge now reads Apache-2.0; the actual LICENSE file + corrected License section arrive via #4 (repo had none, and main's License section claimed MIT against a dangling link). |
Targeted documentation fixes — no rewrite; existing reference content (quick start, command/recipe tables, caching, cross-compilation, Lua API, examples) is untouched.
install.sh
REPO="anomalyco/mustfile"→REPO="gregnazario/must", so the installer resolves latest-release metadata, archives, andSHA256SUMSfrom this repo instead of a nonexistent one..github/workflows/release.yml. The workflow uploadsmust-<target>.tar.gz(x86_64/aarch64-unknown-linux-gnu,x86_64/aarch64-apple-darwin) plusSHA256SUMS— exactly what the script constructs (must-${TARGET}.tar.gz, checksum grep matchessha256sumoutput format). No asset-name changes were needed.sha256sum, which does not exist on stock macOS. Added a tinysha256_filehelper that preferssha256sumand falls back toshasum -a 256. Without this the script would abort on every Mac even after the repo fix. Passessh -nandshellcheck -S warning.README.md
.github/workflows/ci.yml) + MIT License badge.curl -fsSL https://github.com/gregnazario/must/releases/latest/download/install.sh | sh(install.sh is uploaded as a release asset by the release workflow), alongside the existing cargo install.must-<target>.tar.gz/.zipassets +SHA256SUMSattached to each GitHub Release.site/mkdocs.ymlsetssite_url: https://must.ai;deploy-docs.ymlwrites amust.aiCNAME).Notes / follow-ups (not touched here)
.github/workflows/release.yml's generated release body still hardcodesanomalyco/mustfilein its curl/brew snippets and references ananomalyco/tapHomebrew tap — left alone as out of scope for this PR, but it will publish wrong install instructions on the next tag.