Tagged as: InternshipDocumentationWavedromWaveform

WaveDrom Documentation Generation

Sigasi develops an integrated development environment (IDE) that makes chip designers more productive. Our IDE, Sigasi Visual HDL, based on Visual Studio Code (VS Code), is focused on VHDL and SystemVerilog, the two most common hardware design languages.

Like most IDEs, Sigasi supports the generation of documentation from comments written in the code. These comments can be written in Markdown. For hardware designs, it’s good practice to supplement textual documentation and specifications with waveform diagrams. These visualizations show the relation between the input and output of a design.

In comes WaveDrom: an application to draw waveform diagrams from a textual format called WaveJSON. In this internship, we aim to support WaveJSON in code comments, to show rendered waveform diagrams in the generated documentation. The goal is twofold: waveforms should be rendered properly wherever code comments are being visualized, and the user should get some decent support when writing the WaveJSON snippets. The tool should assist with code completion and validation of the comment snippets to ensure that they can be rendered to valid waveforms. It is part of the internship to explore options and come up with pragmatic yet sustainable ideas about how to achieve this and deliver the feature.

This internship was picked by Joran in summer 2026, resulting in some very nice work and a blogpost: Meet Our Intern Joran De Decker.