Member-only story

Keep your Documentation updated with Cypress and GitHub Actions

Ema Suriano
9 min readNov 3, 2020

--

A bunch of pictures

One of my favorite ways to document projects is by adding screenshots of how it looks, to provide a quick overview of what it does and looks like. Sadly these images are quite easy to get out-dated, and I was being forced to manually update them … In this post, how I automatize this task by using Cypress and GitHub Actions.

My own Experience

I am the owner and maintainer of the Gatsby Starter Mate, which allows developers or tech writers to bootstrap their portfolio and manage its content with a CMS.

Although one can always open the Demo website and navigate through it to see how the project is, I decided to create a simple Table where I show how each of the sections looks like. Here is the table extracted from the README.md.

Home

Landing Section

About me

About me Section

Projects

--

--

Ema Suriano
Ema Suriano

Written by Ema Suriano

Software Engineer during the day, cook at night 👨‍🍳 Traveler and Foodie 🧳 Berlin, Germany📍

Responses (1)

Write a response