skiptools / skiptools/skipstone

`skip doctor` / `skip checkup` should have searchable error codes

Open
#173 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
106
Forks
20
Avg merge
2d 3h
Merged PRs (30d)
9

Description

When skip doctor / skip checkup fails, it's up to the user to try to fix it. Often, they respond by posting on Slack or on the Github discussion forum. In the best case, they include their log, and they have to wait for someone to respond to them. (In the worst case, they forget to include the log, and their report is unactionable.)

Instead, skip doctor and skip checkup should detect common installation issues and report them with a searchable error code, e.g.

[SKIP-DOCTOR-ERR-CODE-1] Gradle not found

Those error codes should show up on https://skip.dev/docs/help/ (which is currently mostly nearly blank).

The goal would be for the user (and/or an LLM) to be able to clearly identify not just what the problem is, but how exactly to fix it, without human interaction.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin at the skip doctor and skip checkup command entry points and review how common installation failures are currently reported. Read the help page at skip.dev/docs/help/ and define the error-code coverage and fix guidance needed for each documented failure. Done means the commands emit searchable codes and the help page explains how to resolve them.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
cli, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.