This site hosts the internal documentation for developers working on Enso and Enso projects. Most of the documentation is currently drawn from the Enso engine.
If you want to add documentation for another project, see the instructions below.
Installation and usage
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
Adding new documentation
To add new documentation:
- Add a new submodule under
- 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.