Connect your GitHub docs

The GitHub workspace is available in the local development preview, with both the editor and Laravel backend running. It is a single-operator build: team sign-in and member permissions are not available yet. The website’s browser demo does not connect to GitHub.

Prepare a test repository

Create a repository on GitHub and initialize it with a README so it has a branch. Add a few representative Markdown files. Start with a test repository while validating the workflow.

Open the local app and choose GitHub repositories. All connections and submissions happen through the UI; you decide when GitHub receives a change.

Connect a repository

Click ＋ Connect repository. Enter its GitHub URL or owner/repository, and optionally an existing branch. Leaving Branch empty uses the default branch.

Use the dialog’s GitHub link to create a fine-grained token for only your test repositories. This build needs Contents: Read and write and Pull requests: Read and write. Your organization may require approval. Enter the token in the connection dialog yourself, never in chat or a screenshot. See GitHub’s token guide for restrictions and setup.

Leave Allow direct commits unchecked for your first test. Pull requests are the default. Connecting reads the repository; it does not create a commit. The backend stores the credential encrypted in its local database.

Include multiple folders

Enter one path per line in Documentation folders. For example:

docs
guides
packages/api/docs

Subfolders are included. Clear the field to include Markdown across the whole repository, including a root README. The default docs value excludes files outside that directory.

Use Folders on an existing connection to change the scope without entering the token again. Removing a folder with changed drafts is blocked until you submit or discard those drafts. A pending submission also blocks scope changes.

Folder scopes apply to a connection. They are not team-member access controls in the current build.

Open and edit a document

Files are grouped by directory. Use Find a document to search paths, then open a file. Edit in visual or source mode and wait for the saved-draft status before refreshing.

Drafts are saved to the local backend, not immediately to GitHub. A save failure keeps your working copy in the tab. Download Save a copy before troubleshooting or closing the page.

Add new Markdown files

Choose an Upload folder, then drop .md files onto the document area or use its file picker. Uploads create local drafts with a New badge. They reach GitHub only after review and submission.

You can upload up to 25 files per batch, 1,000,000 bytes per file and 10 MB total. Drop files, not folders. A filename conflict rejects the batch without replacing the existing document. Open an existing document from the file list to edit it.

Switch repositories

Connect another repository through the same dialog, then use the Repository picker. The current draft is saved before switching; a failed save keeps you in the current repository. Identical document paths in different connections have separate drafts.

Reconnect the same repository and branch to replace an expired token. Disconnect removes the local connection and its stored credential once changed drafts and pending submissions are resolved. Revoke the token on GitHub separately if it is no longer needed.

Next: Review and save explains pull requests and direct commits. Add images covers screenshots and image assets.