Contribute To The Docs

The Cleftly documentation is created in Markdown and served as a static site using Material for MkDocs.

The documentation can be found in the /docs directory in the repository.

Run Development Server

Requirements

• Python 3.11+
• Poetry

Run

poetry install
poetry run mkdocs serve

Publish changes

Updates are automatically published to GitHub Pages via GitHub Actions.