Skip to content

EventStore/documentation

Repository files navigation

EventStoreDB documentation

EventStoreDB is an open-source, functional database with Complex Event Processing in JavaScript.

This repository maintains documentation for EventStoreDB (imported from the server repository on build), Event Store Cloud, client SDKs, and other tools and product provided by Event Store.

Contributing

Feel free to create a GitHub issue if you have any questions or request for more explanation or samples.

We're open to any contribution. If you noticed some inconsistency, missing piece, or you'd like to extend existing docs - we'll be happy to get your Pull Request.

Note that EventStoreDB documentation is located in the server repository. Open issues and PRs for server documentation in there.

Please make sure to follow the contribution guidelines. It contains detailed information on how to contribute to the documentation.

Samples

EventStoreDB clients:

Local development

Read the local development guide to learn how to run the documentation locally.

Algolia Search

Documentation is using Algolia DocSearch service for indexing and searching through the contents. Currently, the search indexes are updated by Algolia Crawler and can only be configured on the Crawler dashboard.

If you notice any issues with the search, please create an issue in this repository.