Skip to content

docs: add installation troubleshooting guide - #21

Merged
Maxerns merged 2 commits into
getsotto:mainfrom
Nomee-123:docs/installation-troubleshooting
Sep 10, 2026
Merged

Maxerns merged 2 commits into
getsotto:mainfrom
Nomee-123:docs/installation-troubleshooting

Conversation

@Nomee-123

Copy link
Copy Markdown
Contributor

Summary

  • Add a compact troubleshooting guide for installation failures.
  • Document next steps for version, asset, download, Sigstore, checksum, and platform errors.
  • Include links to Sotto releases and the repository issue tracker.

Closes #16

Signed-off-by: Nomee Singh <singhnomee@gmail.com>

@Maxerns Maxerns left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Nomee-123 the structure, next steps, and links are all good, and keeping the pins/examples untouched is exactly right.

There’s one blocking issue before this can merge:

Restore the missing error messages

All six ### headings are currently empty, and a few inline code spans also came through blank, for example:

in  format, such as .

The purpose of this guide is to map the actual installer wording to the correct next steps, so each error message needs to be restored as an inline code span, copied verbatim from the scripts.

Please restore the following:

  • sotto-version must be an exact release such as v0.4.0

    • Source: scripts/validate-version.sh / .ps1
  • release asset not found: …

    • Source: scripts/install.sh / .ps1
  • download failed: …

    • Source: scripts/install.sh / .ps1
  • Sigstore verification failed for …

    • Source: both installers
  • checksum verification failed for …

    • Source: scripts/verify-checksum.sh / .ps1
  • no prebuilt Sotto binary for …

    • Shell wording uses $os/$arch
    • PowerShell wording uses Windows/$Architecture

Happy to re-review once those are restored.

Signed-off-by: Nomee Singh <singhnomee@gmail.com>

@Maxerns Maxerns left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Nomee-123 for the updates.

@Maxerns
Maxerns merged commit 592c7ec into getsotto:main Sep 10, 2026
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README: add a short troubleshooting guide for installation failures

2 participants