FAQing Cool

Make cool web tutorials. Think VHS, but for the web.

FAQing Simple

Write FAQs in clear, concise YAML—no fluff, just steps.

version: 1
title: Create a repository
voice: en-GB-Chirp-HD-D
url: https://github.com/
steps:
  - - say: In the upper-right corner of any page, click on the plus sign
    - click: "#global-create-menu-anchor"

  - - say: Then click New repository.
    - click: '[tabindex="0"][href="/new"]'

  - - say: In the 'Repository name' box, type hello-world.
    - type: hello-world
      to: '[aria-describedby="RepoNameInput-is-available RepoNameInput-message"]'

    - say: >
        In the 'Description' box, type a short description. 
        For example, type 'This repository is for practicing the GitHub Flow.'
    - type: This repository is for practicing the GitHub Flow.
      to: '[aria-label="Description"]'

    - say: Select whether your repository will be Public or Private.
    - click: '[value="public"]'

    - say: Select add a read me file.
    - click: 'input[type="checkbox"]:not(#include_email)'

    - say: Click Create repository.
    - click: 'button[type="submit"]:not(.btn)'

FAQing Safe

FAQs are compiled, tested, and always in sync.

> faq compile new-repo.yml && faq upload new-repo.json

FAQing Small

FAQs are usually 100× smaller than traditional videos.

FAQing Open

faq.cool is an open source project. Star it if you like it!