Quickstart

Get started with AutoScribe in just a few steps. This guide will walk you through installing AutoScribe, setting up continuous documentation, and triggering your first code generation.

1️⃣ Intall AutoScribe

Install AutoScribe on Github Marketplace

GitHubGitHub

2️⃣ Configure AutoScribe

Place a autoscribe.yml file at the root of your repo, in the branch where you're working on e.g. main or a feature branch.

Example

# AutoScribe minimal config
target_url: "docs/"

# Branch to trigger documentation (default: main)
branch: "main"

What the config means:

target_url: Relative path to existing or future docs folder.

branch: Branch name on which docs will be triggerd from commit.

3️⃣ Commit your code

As soon as you commit autoscribe.yml:

• AutoScribe initializes and runs the documentation.

• Creates a branch: autoscribe/docs/<commit_sha> with updated docs, and create a pull request to merge with your branch

Code and let AutoScribe auto-update your Docs ⚡ !