docs: lead with the download page instead of git clone - #124
Open
sorenwacker wants to merge 1 commit into
Open
sorenwacker wants to merge 1 commit into
sorenwacker wants to merge 1 commit into
Conversation
The release pipeline builds installers for three platforms and publishes them, while both entry points opened with Node 22 and git clone. The only documented way in was to be a developer.
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.
The release pipeline builds a DMG, a Windows installer and an AppImage and publishes them to https://sorenwacker.net/nodus/. Both entry points into the project opened with Node 22, npm, Git and
git clone— so the only documented way in was to be a developer, and the artifacts went unused.The README now opens with Download, and the installation guide leads with it and says plainly that the rest of the page is only needed to develop the app.
First launch is part of the download
The builds are unsigned, so a download with no instructions is worse than none — the app appears broken on first open. Both pages carry what each platform needs:
xattr -cr "/Applications/Graph Core.app"then openchmod +x Graph-Core-*.AppImageThis is the same text the release notes already carry, now visible before the download rather than after it.
Also corrected
The README still offered
npm run dev # Web onlyas a way to run the app. Since #123 the renderer refuses to start outside Electron, so that line described something that now fails by design. It says whatnpm run devactually is: a build stepelectron:devruns for you.Gate
src/__tests__/downloadLinkPresent.test.jsholds both entry points to it: the download URL is present, it appears before anygit clone, and the macOS first-launch step is stated. Proven red against the pre-change docs — 4 of 6 assertions failed.Full suite: 1876 tests passing.
🤖 Generated with Claude Code
https://claude.ai/code/session_01TPst4QxhW8kaFtN3K9s4e1