dagshub-docs/docs/feature_guide/reports.md

Reports

Writing reports in data science projects is a common method of sharing and preserving knowledge. Being able to write these reports wherever you work is useful in creating a central source of truth. With Reports, you can now host your research notes in the same place you host code, data, models, and experiments and build your knowledge base as you go. The Reports tab lets you do exactly this - in a convenient, notion-like, what you see is what you get (WYSIWYG) editor.

DagsHub reports supports full GitHub-flavored markdown.

_{Reports tab}

Reports Tab

The Reports tab is where you see all the reports that have been created in your project.

For each report you can see the last time it was edited, and behind the scenes all versions are saved in a separate Git Repository which you can access via the URL in the top right of each report page.

_{Report Git Location}

What you see is what you get editor

We wanted the process of writing and editing reports to be as convenient as possible, so we integrated a beautiful WYSIWYG editor. This comes with a LOT of cool new capabilities out of the box.

Quick shortcuts with the / menu

Creating a header, a bullet list or a code block is really intuitive with keyboard shortcuts. Even if you forget the exact shortcut for something just use the quick menu by typing / and all the shortcuts will appear.

_{Quick shortcuts}

Mark text - add styles

Need to make your text bold? Add a link? Just mark the text and add the styles you need.

_{Adding styles with text highlighting}

Math equations

Equations are easy to add, and you can see how they'll look while typing them in.

_{Math equations in reports}

Diagrams

Mermaid diagrams are also supported, so you can create beautiful flow charts, pie charts, and a bunch of other charts easily.

_{Mermaid charts in reports}

Image Drag n' Drop

Want to add an image? Just copy the file and paste, or drag it into the editor – everything will automatically be taken care of.

_{WYSIWYG Report Editor}

Found an issue with reports?

If you encounter any issue or think our magical Report editor should support other formats - please let us know on our Discord channel.