DEV Community

Cover image for Hacktoberfest PR 3: Improving documentation
TD
TD

Posted on • Edited on

Hacktoberfest PR 3: Improving documentation

This week I got the opportunity to improve the developer contribution documentation for the Telescope project.

Overview

When I was working on a fix for this issue locally on my machine, I ran into a problem where I was unable to see any blog posts, even though I used the environment-setup file as my guide to setup Telescope. Since the bug I was trying to fix did not require access to blog feeds, I filed a separate issue on GitHub.

The Problem

The problem was that the environment-setup file was missing information on properly seeding the database utilized by Telescope. The needed information was in a separate file.

The Goal

My goal was to enhance the developer experience by correctly integrating all the information related to running Telescope in one file - environment-setup.

information Added

Image description

The Outcome

Users can easily navigate to different files to initialize the database. All the steps are in one file

Thank you Josue, for your help and support.

Top comments (0)