litmuschaos/litmus-docs

Litmus-docs is the documentation repository for the Litmus Project, a chaos engineering platform built with Docusaurus.

The repository serves as the central reference for users and developers working with Litmus. It contains guides, API documentation, and tutorials needed to understand and implement chaos engineering experiments. The documentation is built using Docusaurus, a static site generator that compiles markdown and JavaScript into a browsable website hosted at docs.litmuschaos.io.

Developers setting up the documentation locally can choose between manual setup or Docker Compose. The manual approach requires Node.js 16.14 or above and involves cloning the repository, installing dependencies, and starting a development server that runs on localhost:3000. Docker Compose offers an alternative for those preferring containerized setup. Before committing changes, contributors must run the embedmd tool, which extracts and embeds code snippets from external files or URLs into documentation files, ensuring code examples stay synchronized with their source.

The project maintains an active documentation workflow with tooling requirements that enforce code freshness. Contributors are expected to run embedmd before committing to prevent stale code examples. The repository accepts contributions through standard open-source channels and maintains translations in multiple languages alongside the primary English documentation. Setup is straightforward for developers familiar with Node.js environments, and the Docker Compose option lowers barriers for those without local Node.js installations.