Home

What is it?

Documentation can tell you how to do something, but can't do it for you. Speedrun can. Speedrun is a power up for GitHub markdown that infuses documentation with the ability to prompt for inputs, run JavaScript code, reference centralized configuration and seamlessly get credentials for authorized users. Now your documentation is a tool with the context necessary to do what you want with a simple click.

Why?

When you document how to do something, you are only getting someone half-way there. Someone can find your steps and follow them, but they are still responsible for setting up their environment, getting credentials, and replacing inputs. Any mistakes and they have lost time. You can create a tool that makes it easier, but you need to deploy it, patch libraries and manage hosting infrastructure. Speedrun gets your users the whole way there by enabling you to build documentation and tools at the same time with instant, serverless hosting.

When?

flowchart TD
    A[Build a tool] --> B{Do you want to do it fast?}
    B -- Yes --> C
    C[Use Speedrun]
    D[Use something else]
    B -- No --> D

Loading

Use Cases

1. Creating documentation that can do it for you
2. Creating executable runbooks
3. Dynamically deeplinking into the AWS console or any website
4. Wrapping a command line with a UI
5. Reducing toil, clicks, and user error
6. Enabling a non-technical user to click a button to do something
7. Encouraging least privilege access by reducing effort to use scoped-down roles
8. Encouraging a "Fix It" culture, it's easier to do it than put it in the backlog
9. Embedding iframes in your documentation
10. Auditing who did what, every AWS interaction is associated with a user and can be traced in CloudTrail

Getting Started

Follow the Getting Started guide