Set up docs/CI in repo

Open
  • Is something wrong?
#7 3 comments 0 reactions 1 assignee View on GitHub

@axl1313 is already working on this.

Since Dec 18, 2025.

Assessment

This issue has not been assessed yet.

Description

See Anish's recommendations (from #tlm Slack channel):

  • Project manager and build backend: Hatch and Hatchling
    • I see you're already using this
  • Installer: uv (via installer = "uv" option in pyproject.toml)
    • Lot faster than the default pip installer
    • For a Python library using Hatchling as the build system, I don't think you need the .python-version or uv.lock
  • Code quality and CI: GitHub Actions, Mypy, Ruff (via hatch fmt), Pytest (via hatch test), Codecov
  • Docs: mkdocs-material and mkdocstrings-python, built in GitHub Actions and hosted using GitHub pages (via artifact, not branch)
    • Popular libraries like Pydantic AI and DSPy use mkdocs-material, you could take inspiration from their configuration. I also used this documentation system for a personal project a couple months ago, feel free to copy configurations from there.
Dominant language
Python
Stars
9
Forks
6
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cleanlab/tlm

All issues in cleanlab/tlm

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.