This site contains the documentation for the two major sub-projects of Enso, the engine, and the IDE.

• Engine
• IDE
• Rust-Libs

The site is built with Jekyll, and hosted on GitHub Pages. The content is mostly hosted in other repositories via Git submodules.

bundle install
git submodule update --init --recursive
bundle exec jekyll build

To add new documentation:

• Add a new submodule under _submodules.
• Create a symlink to the desired repository at the root.
• To the target repository, add a GitHub Action to automatically checkout the submodule when changes are made.
• If you want fine-grained control over presentation and order of the documents, you can add a yaml frontmatter block to your files. See the engine docs for an example.

The docs are deployed to enso.org via the docs-publish.yml GitHub Action. They get put in the docs/developer subfolder of the gh-pages branch. This gets deployed alongside the other enso docs pages.

This site uses the Gitbook Jekyll theme, by sighingnow.