📚 Resonate Docs: Providing documentation for Resonate’s tech assets

I’ve built out a docs/wiki website for our tech assets for our software developers.

Right now it automatically imports the Readmes from all of Resonate’s public code repositories of any significance and lays them out in a sequential and digestible fashion. This way, when we update the Readme on an existing repository, this wiki will also update (I believe we just need to run ‘USE_SSH=true yarn deploy’ from inside the repository directory and it downloads the updated Readmes and pushes out an updated build to the website). Kudos to @jeremy for the help researching and recommending documentation libraries that would be suitable for this.

We’ll want to improve upon this and expand on what’s here. This is just a first iteration and first step.

Here’s the repository. Feel free to create issues/pull requests if you see anything that needs changing, or discuss it in this thread.

Also, if you’re interested in seeing an overview of how this work is progressing, please check out the Kanban-style Project Board for the repository.

12 Likes

This is so great! Thank you to everyone who has contributed here!

@Hakanto @peterklingelhofer @peter @auggod @Nick_M @angus @merefield @jeremy @jackhajb @psi @boopboop @Timothee @replygirl @alexcrane @onapoli @fgblomqvist @datafruits @marie @pando

Who am I missing?

5 Likes

This is fucking AMAZING.

We have needed this for YEARS.

THANK YOU.

4 Likes

Great work, Peter!

2 Likes

Today, four newly open-sourced Resonate repositories were added to the docs website! :tada:

User color preferences are respected (if you load up the docs website while your computer or phone are in dark mode the website will load in dark mode):

The navigation bar now includes a clickable GitHub logo button that takes you to our GitHub organization, rather than just a text link that says GitHub:

3 Likes

Another update went live moments ago: an Edit this page button has been added to the bottom of each set of instructions so users can easily update/modify/add to the instructions as they see fit by submitting a pull request via the link. We want to make updating our documentation as easy as possible, and I think this is a great first step!


2 Likes

As of today, we now have search functionality as well! :tada: Check it out:



3 Likes

Killing it @peterklingelhofer, really putting in the motivation for writing better docs in our repos.

3 Likes