Archives at a Glance

Archives at a Glance

What are Artemis Archives?

Artemis Archives are standalone pieces of visual documentation generated by Artemis' documentation system. These archives showcase your code alongside a notebook-style document that features both static documentation content (Markdown, LaTeX, multimedia, etc.) and runtime artifacts (tables, graphs, slideshows, 3D models, and more).

These Archives can be used as vehicles to share your work with your team, but their real purpose is to be uploaded to the Artemis Dashboard so they can be viewed across your entire organization.

How do Artemis Archives work?

Archives Archives are created in two easy steps. First, insert special in-line comments called Anchors into your code to tell our system which static content to generate and runtime variables to capture. Then, run your codebase with Artemis' command-line utility, and Artemis will run your codebase and automatically generate the documentation for you in real time. This documentation takes the form of a standalone HTML document.

Archives present content generated from Anchors in the form of cards. These cards showcase groups of information relevant to a particular section of code. When you launch an Artemis archive, you can either choose to immediately view its entire contents, or you can step through it as if you were running your code to see these cards in the order in which Artemis encountered the anchors that generated them while running your program. Alternatively view these cards based on assigned sections (background, introduction, methods, results, etc.)

12801280

Every card is linked to the code that generated it on the side, so you can click on any card to immediately find the code that corresponds to it. Likewise, you can click in region of code, and if that region of code corresponds to a particular card, Artemis will automatically navigate to and highlight that particular card.