Editing Lab Instructions with GitHub vs. Studio

Overview

Lab instructions can be edited in two ways, depending on how the Lab Profile is configured:

• In GitHub (default behavior)
• In Skillable Studio using Edit Locally

Understanding how each workflow operates, and when to use it, helps prevent lost changes and keeps content in sync.

Edit in GitHub (Default)

Use this workflow when Edit Locally is OFF. GitHub is the source of truth, and Studio is read-only.

How It Works

1. A change is made to the instruction file in GitHub.
2. The change is committed to the primary branch.
3. GitHub triggers a webhook to notify Skillable of the update.
4. Skillable retrieves the updated file and stores it locally.
5. The next time the lab or editor is opened, the updated instructions are displayed.

In Studio, the Instructions Editor is read-only. A banner indicates that the lab uses an external Instructions Source. The content reflects the latest synced version from GitHub.

Key Considerations

• All edits must be made in GitHub
• Updates are applied automatically via webhook
• Studio cannot override or modify the content

If you need to pull the latest content from GitHub immediately (without waiting for a webhook), use the Resync option in the Instructions Source section of the Lab Profile.

Resync manually retrieves the latest version of the configured instruction file from GitHub. It is useful when a webhook may have been missed or when no recent commits have triggered an update.

Edit in Skillable Studio (Edit Locally)

Use this workflow when Edit Locally is ON. Edit in Studio and sync changes back to GitHub.

How It Works

1. Edit Locally is enabled on the Lab Profile.
2. The Instructions Editor becomes writable.
3. Changes are saved in Skillable as you edit.
4. Labs immediately reflect the updated content.
5. When ready, sync your changes to GitHub by creating a Pull Request (PR).
6. The PR is reviewed and merged into GitHub.

In Studio, the Instructions Editor is fully editable. Changes are saved automatically. A Sync Changes option is available when you make edits.

GitHub webhooks still fire when changes are committed. However, incoming updates don't overwrite local edits while Edit Locally is enabled.

Key Considerations

• Skillable temporarily holds the working version of your content
• GitHub remains the system of record after changes are merged
• You are responsible for syncing changes back to GitHub

Mode Switching and Data Loss

Switching between workflows changes how content is managed. If done incorrectly, it can result in permanent data loss.

Disabling Edit Locally

If you turn off Edit Locally while there are unsynced edits:

• Your local changes are permanently lost
• The lab reverts to the version stored in GitHub

You will see a warning before confirming this action.

Summary

Lab instructions can be managed either in GitHub or Studio, depending on your workflow. GitHub provides a structured, version-controlled process. Edit Locally in Studio provides flexibility and faster iteration.

Choosing the right workflow, and switching between them carefully, ensures your content stays consistent and avoids data loss.

Related Resources

• GitHub Instructions Source
• GitHub Repository
• Editing Locally for GitHub Instructions
• Troubleshooting GitHub Instructions