Documentation Conventions

Front matter

Each HTML page must begin with YAML front matter. Use the following template and adjust values as needed:

---
layout: default
title: "Page Title"
description: "Short summary of the page"
nav_order: 10
---

Headings

Use a single <h1> that matches the page title.
Structure content with <h2> for sections and <h3> for subsections.
Do not skip heading levels.

Referencing the README

Avoid duplicating long explanations that already exist in README.md.
When original content remains in the README, link to it using relative paths, e.g. Installation.
Summaries may be included on Pages when useful, but keep the README as the canonical source for full instructions.

Links

Use relative links with explicit file extensions, e.g. Quick API.
Prefer ./ for same directory and ../ for parent directories.
Verify links before committing using a link checker such as lychee: lychee docs/**/*.html.

Migration checklist

Highlights

[ ] Create docs/highlights.html.
[ ] Add front matter and a single H1.
[ ] Summarise key benefits in bullets and link to predictor pages and Quick API.

Installation

[x] Create installation.html.
[x] Outline full install instructions including optional numba acceleration.
[x] Reference requirements from README to avoid divergence.

Reproducibility

[ ] Create docs/reproducibility.html.
[ ] Document OS, hardware, Python version and environment recreation steps.

Quick API

[ ] Create docs/quick_api.html.
[ ] List public objects with brief descriptions.

Method matrix

[ ] Create docs/method_matrix.html.
[ ] Translate table of implemented methods for each object.

Experiments & Benchmarks

[x] Create experiments_benchmarks.html.
[x] Summarise available scripts and link to results in benchmark/.

Key parameters

[ ] Create docs/key_parameters.html.
[ ] Describe tunable hyperparameters and their effects.

Performance tips

[ ] Create docs/performance_tips.html.
[ ] Provide guidance for speeding up computations and scaling to high dimensions.

Limitations

[x] Create docs/limitations.html.
[x] Clarify algorithmic and practical constraints.

Images

[ ] Create docs/images.html.
[ ] Explain omission of binary assets and reference external repositories if needed.