Event Store documentation
This repository is no longer being maintained in favour of the new documentation repository, which is available here.
What follows is documentation for how to use and contribute to the Event Store documentation. If you’re planning to make updates or contributions then read on. Otherwise, head on over to the website.
The Event Store documentation consists of different components, and the documentation reflects this. Depending on what you want to contribute to, the process is different.
This is the bulk of documentation, and where you mostly likely want to contribute. It uses 'DocFX flavored Markdown'. It is similar to standard or GitHub Flavored Markdown, but adds features useful for documentation you can find details of here.
In additions to conceptual docs on the HTTP API, the documentation includes an OpenAPI spec file that DocFX renders to HTML when building the site. Any contributions to that file are welcome, read the OpenAPI spec for more details on the format of that file.
Finally, if you would like to improve the theme for the documentation site, then you can find its repository here.
It is possible to clone this repository, and build and serve using the command below, but components are missing, DocFX generates a couple of warnings about missing content, and uses the default theme.
To have everything you need to fully generate the site, clone the following repositories into the same parent directory as the documentation repository:
You need the website for the top menu to work as on live. If you only need to preview the documentation locally, it is not needed.
Follow the instructions here to install DocFX and dependencies, then run the command below in the
documentationdirectory to generate documentation from code comments:
docfx metadata docfx.json
And the command below to generate the rest of the site and serve:
docfx build docfx.json --serve
This builds the site to the
/_sitefolder and serves it at
The content of our documentation has multiple authors. Formatting and style guidelines help maintain a consistent use of language throughout the docs.
You can also use the build.sh file in this repository to do most of these steps for you, and then run the Jekyll eventstore.com site to serve the entire site, or
docfx build docfx.json --serveto only serve the documentation.
Then to get docs changes to eventstore.com, create a new PR with the generated HTML files in the eventstore.com folder. Any changes made to this repository are not automatically deployed anywhere.