DEV Community

loading...
Doctolib Engineering

Run Code Tours without leaving Github

qmenoret profile image Quentin Ménoret ・1 min read

tl;dr: I made this: https://github.com/doctolib/code-tours-github

Code tours

Code tours are an amazing tool to help people discover your codebase. It's simple and brilliant!

Basically, you will be able to walk people through the code, highlighting specific parts of the code with your explication. It's great to explain how a feature work, or how you apply certain patterns.

Here is what a Code Tour looks like:

What Code Tour looks like

Only in VSCode?

Unfortunately, this extension is built for VSCode. They recently added support for CodeSpace as well, but that's basically it. Since I'm not using VSCode, I felt like I had to do something about it!

Introducing the Code Tours Github extension

So I decided to reimplement part of the features directly in the Browser. This way, Code Tours are available to everyone!

Here is what a tour looks like:

Code Tour using the Browser Extension

Of course there is still a lot to do to have as many features as the original extension, but I'll keep working on it.

You can check the repository here, and install the extension for Chrome or Firefox.

Let me know what you think!

Discussion (0)

pic
Editor guide