breatheco-de / breatheco-de

https://breatheco-de.vercel.app
1.13k stars 2.44k forks source link

Onboarding setup for learnpack #7706

Open alesanchezr opened 2 months ago

alesanchezr commented 2 months ago

We want to introduce the possibility of suggesting an agent and mode inside the learn.json to help learniners configure learnpack quickly.

    editor: {
      mode: null, // [extension, preview]
      agent: null, // ["vscode", "os"] ("os" is the agent when running outside a coding editor
      version: null, // By default downloads the latest version
    },

The learnpack extension will use the welcome panel that is currently almost empty as an onboarding panel with some information for the user.

If you don't have node

The vscode extension can detect if the node is installed and open a bug horrible tab saying that you must install a node before using learnpack.

If you don't have learnpack cli installed

The vscode extension can detect if learnpack is installed, if not, it can try installing it globally in the computer.

If you don't have the vscode extension

If the suggested agent is "vscode" and you are running the learnpack start command without having the learnpack vscode extension installed we should try and install it ourselves. If could also happen that you have the extension but its disabled, lets we can suggest to enable it or enable it ourselfs.

Suggested agent != detected agent

We show a warning on the vscode welcome panel but also a modal window on the learnpack ide warning you about it, something like:

agent=vscode We noticed you not running this tutorial inside Microsoft VSCode, we strong recommend doing it for a better learning experience. Here are some steps on how to install VSCode and the Learnpack VSCode extension.

agent=os This learning package was designed to run outside of VSCode, we strongly recommend closing VSCode and running the package independently by opening a new terminal and running the command : learnpack start

github-actions[bot] commented 3 weeks ago

This issue is stale because it has been open for 30 days with no activity.