Skip to content

Contributing Documentation

MedUX documentation lives alongside the code in the docs/ directory and is built with ProperDocs (a MkDocs fork) using the Material for MkDocs theme.

Setting Up

  1. Clone the repository and set up the development environment as described in the Developer Setup guide.

  2. Install the documentation dependencies:

    bash uv sync --group doc

  3. Start the documentation dev server (with the venv active):

    bash source .venv/bin/activate properdocs serve

  4. Open http://127.0.0.1:8000/ to see the live preview. Changes to .md files are reflected immediately.

Structure

The documentation is organized into these sections:

  • overview/ — project overview and architecture
  • user/ — end-user documentation
  • admin/ — administrator documentation
  • developer/ — developer documentation
  • contribute/ — contribution guides (this section)

Writing Guidelines

  • Write in English
  • Use clear, concise language
  • Use admonitions (!!! note, !!! warning) for callouts
  • Use code blocks with language identifiers for syntax highlighting
  • Keep pages focused on a single topic
  • Link to related pages where appropriate
  • If documenting a feature you are unsure about, add a <!-- TODO: ... --> comment rather than guessing