Repository navigation
Shorten the README and move details into docs - #266
Conversation
The README was a 234-line reference manual. It is now about 80 lines: pitch, install, a per-platform matrix of every channel (app stores and command line), and links out. Editor setup, ACP support, terminal mode, telemetry, install details and distribution notes moved into docs/ unchanged apart from two corrections. winget ID is getSigit.siGitCode, as in the manifest and winget-pkgs, not smbCloud.siGitCode. The AUR entry is removed since new AUR accounts are closed and there is no way to publish there. The README also says the snap is the desktop app, not the CLI. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
![sigit-code-review[bot]](https://avatars.githubusercontent.com/in/3492899?s=60&v=4){kind=small}
There was a problem hiding this comment.
The README is now much shorter, focusing on a concise pitch, three main install commands, a matrix of distribution channels by platform, and links to detailed docs. All setup, protocol, and platform details have moved into the new docs/ directory, which now contains install, editor, ACP, terminal, telemetry, and distribution guides, plus an index. The README and docs now correctly use the winget package ID getSigit.siGitCode and remove the AUR entry, reflecting upstream changes. The Snap install note clarifies it installs the desktop app, not the CLI. All links and commands have been checked for accuracy. No critical or warning-level issues are present in the new documentation structure or content.
Automated review by siGit Code Review · commit af218c9 · see the review dashboard
Adds release, CI, GitHub downloads, NuGet, winget, PyPI downloads and a VS Code Marketplace link badge. The Marketplace version badge from shields.io is retired, so that one is a static link. The notice line under Copyright is removed. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
|
siGit Code Review couldn't finish this review: the model service was unavailable. Mention @sigit-code-review to try again. Automated review by siGit Code Review · commit 7c8ecbe · see the review dashboard |
Say the app embeds the same siGit Code as an in-process agent, drop the links to the private sigit-app repo in favour of the download page, use the Onde Inference on-device inference SDK wording, and add JetBrains IDEs and other ACP clients to the editor guide. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
This update further shortens and clarifies the README, fixes the winget and AUR notes, and improves the documentation structure. The README now features a concise pitch, updated badges, a corrected Onde Inference link, and a matrix of install channels that now points direct downloads to the unified download page. The editors.md now documents JetBrains IDE setup (including Android Studio, RustRover, RubyMine) and links to the ACP client list for other editors, as requested in earlier review threads. distribution.md now describes the app as embedding the same agent, links to the download page, and uses the correct Onde Inference SDK wording. All previously open threads are addressed in this diff. No new structural or correctness issues are introduced in these changes.
Automated review by siGit Code Review · commit b048b7f · changes since af218c9 · see the review dashboard
The JetBrains section now names the IDEs we tested (RustRover and RubyMine) instead of listing IntelliJ IDEA and Android Studio. Android Studio gets its own section: Bring Your Own Agent is a Canary preview, and siGit Code installs from the agent registry under Settings > Tools > AI > Agents. marimo is added to the other ACP editors. The direct-download links in the README and docs/distribution.md now point at https://getsigit.5mb.app/download, which serves the installers. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
|
siGit Code Review couldn't finish this review: the model service was unavailable. Mention @sigit-code-review to try again. Automated review by siGit Code Review · commit 0d4568d · see the review dashboard |
The README was 234 lines of install tables, editor setup and protocol reference. It is now about 80 lines: a short pitch, three install commands, a matrix of every channel by platform (app stores and command line), and links to docs/.
Moved into docs/, verbatim apart from the two fixes below: install.md, editors.md, acp.md, terminal.md, telemetry.md. New: distribution.md (every channel, the four app stores, the snap's confinement note) and a docs index. The logo is the 512px app icon at docs/assets/logo.png.
Fixes:
smbCloud.siGitCode. The manifest and winget-pkgs usegetSigit.siGitCode.release-aur.ymlandpackaging/aur/are now dead and can go in a separate change.Wording choices: "on-device inference" for the models, "local" only for where the harness runs. The README says
sudo snap install sigitinstalls the desktop app, not the CLI, and that the app uses siGit Code Cloud while the CLI runs on-device.Checked: relative links resolve (the one broken link,
../src/mcp.rsin docs/mcp.md, was already there). Store, Snap badge and site URLs return 200. crates.io, PyPI, npm, NuGet, the Homebrew tap, the Scoop bucket and winget-pkgs all carry 1.7.5. I have not looked at the rendered page at mobile width.Not here: reverting "local inference" in the package metadata, and a terminal screenshot.