README.md

Imandra-docs

Developing a notebook locally

make docker-dev

Creating a notebook for Imandra Docs

We keep notebooks in markdown in the repo as it's easier to diff them for changes.

There are two key steps for creating a new docs markdown file which will work with our Imandra Docs system:

1. Inside the Jupyter UI do File > Save As and save your file with .md file extension before committing it. Do not use the Download as Markdown command as that will produce files we cannot handle.
2. Add appropriate metadata at the top of the file (using a texteditor outside of Jupyter). It should have the following format:

---
title: "My Awesome Notebook"
description: "My Awesome Notebook Description"
kernel: imandra
slug: my-awesome-notebook
---

Building the docs HTML

First make sure the jekyll-resources submodule is initialised:

git submodule update --init

The first run will take a while but after that notebook execution is cached which speeds things up a lot.

make docker-build-docs IMANDRA_TOKEN=$(cat ~/.imandra-dev/login_token)

Then serve the docs with:

make serve-docs

If your styles are messed up, you might have cached some bad style files - perhaps a build was run before the submodule was initialised. Clean out the asset cache:

cd assets
make clean
make all
cd ..
make docker-build-docs IMANDRA_TOKEN=$(cat ~/.imandra-dev/login_token)

Including images or other assets

To avoid having to do transforms to the notebook contents, we serve all assets out of a cloud bucket. You can add an asset for your own notebook by adding it to the notebooks-assets subfolder, and then running:

make upload-notebook-assets

You can then include an image in your notebook via:

![Image description](https://storage.googleapis.com/imandra-notebook-assets/<filename>.png)

This will work both locally, on the docs site and via try-imandra.