Troubleshooting GitHub Instructions

Prev Next

Overview

This article covers common issues when working with GitHub-based instruction sources and Edit Locally.

Use this article to identify likely causes and resolve problems related to editing, syncing, and GitHub integration.

Common Issues

Issue

Likely Causes

Resolution

The Instructions Editor is read-only, so I can't edit

  • Edit Locally is not enabled on the Lab Profile

  1. On the Lab Profile, click Edit Profile.

  2. Navigate to Advanced > Instructions Source.

  3. Enable Edit Locally.

  4. Save Lab Profile.

  5. Reload the Instructions Editor.

The Sync Changes button isn’t visible

Edit Locally is disabled.

The Sync Changes button is only available when Edit Locally is enabled.

Enable Edit Locally on the Lab Profile (see Enabling Edit Locally for GitHub Instructions).

The Sync Changes button is disabled

No changes have been made since the last successful sync. The current content matches the last synced version.

Make any edit to the instructions. The button becomes enabled as soon as the content changes.

If you believe changes were made and the button is still disabled, reload the editor.

Sync Changes failed and I see an error in the dialog

  • GitHub is temporarily unavailable

  • The configured GitHub token has expired, been revoked, or lacks write permissions

  • Branch protection rules (e.g., required checks or reviewers) blocked the request

  1. Review the error message in the dialog to see where the failure occurred.

  2. Click Retry. Your form data and local edits are preserved.

  3. Verify that the GitHub token has the required permissions (typically repo scope).

  4. If needed, coordinate with your repository administrator to allow PR creation from service accounts.

Local edits aren’t lost when a sync fails. Content is saved in Skillable and is unaffected by GitHub errors.

I turned off Edit Locally and lost my edits

Disabling Edit Locally while unsynced edits exist, and confirming the warning, permanently discards those edits.

There is no automatic recovery. If the content was previously committed in GitHub, you may be able to retrieve it from the repository’s history.


To prevent this issue, always sync changes before disabling Edit Locally.

After merging in GitHub, Studio still shows old content

Skillable doesn’t automatically detect Pull Request merges. The local copy updates only when:

  • A new webhook event is triggered, or

  • A manual resync is performed

  1. Disable Edit Locally to re-enable webhook updates for future commits.

  2. Click Resync on the Lab Profile editor to pull the latest content immediately.

The PR was created, but GitHub shows a merge conflict

Another commit was pushed to the primary branch after your editing session began, resulting in conflicting changes.

Resolve the conflict directly in GitHub using standard merge tools, then complete the merge. Skillable doesn’t manage conflict resolution.

Frequently Asked Questions

A GitHub update occurred while I was editing. Did it overwrite my work?

No. When Edit Locally is enabled, Skillable prevents incoming GitHub updates from overwriting local edits. Webhook events are still received, but the content is not applied while local editing is active.

Summary

Most issues with GitHub instructions relate to:

  • Mode configuration (GitHub vs. Edit Locally)

  • Sync timing (webhooks vs. manual resync)

  • GitHub permissions and repository rules

Understanding how Studio and GitHub interact, and when content is uploaded, helps prevent data loss and ensures a smooth editing workflow.

Related Resources


If you’re experiencing an issue with a lab, platform feature, or your account, please submit a ticket to Skillable Support. Our Support team can help you troubleshoot errors, resolve access issues, and answer questions specific to your environment.

If you noticed an error or have suggestions for improving this documentation, use the Was this article helpful? section below. Your input helps us keep our documentation accurate and up to date.

Was this article helpful?

Please note that this feedback is for documentation only. Be sure to log in to your Skillable account when leaving feedback so we can respond directly.