From 456199fa296f3d121382bc32d7d8577daa71164a Mon Sep 17 00:00:00 2001 From: Andrew Sazonov Date: Mon, 14 Sep 2026 23:28:26 +0200 Subject: [PATCH 1/2] Reorganize reliability factors documentation --- docs/docs/user-guide/analysis-workflow/reliability-factors.md | 3 +-- docs/mkdocs.yml | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/docs/user-guide/analysis-workflow/reliability-factors.md b/docs/docs/user-guide/analysis-workflow/reliability-factors.md index 8261ef6df..328764a88 100644 --- a/docs/docs/user-guide/analysis-workflow/reliability-factors.md +++ b/docs/docs/user-guide/analysis-workflow/reliability-factors.md @@ -1,9 +1,8 @@ --- title: Reliability Factors -icon: material/chart-bell-curve-cumulative --- -# :material-chart-bell-curve-cumulative: Reliability Factors +# Reliability Factors EasyDiffraction reports several complementary measures of agreement between observed and calculated diffraction data. They are ratios diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 3b7ae5379..dce43ea3d 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -222,8 +222,8 @@ nav: - Structure: user-guide/analysis-workflow/model.md - Experiment: user-guide/analysis-workflow/experiment.md - Analysis: user-guide/analysis-workflow/analysis.md - - Reliability Factors: user-guide/analysis-workflow/reliability-factors.md - Report: user-guide/analysis-workflow/report.md + - Reliability Factors: user-guide/analysis-workflow/reliability-factors.md - Tutorials: - Tutorials: tutorials/index.md - Getting Started: From 1bb1de888dd0372cfe17897eea000cf202ce3ad8 Mon Sep 17 00:00:00 2001 From: Andrew Sazonov Date: Tue, 15 Sep 2026 00:42:33 +0200 Subject: [PATCH 2/2] Add reliability factors to User Guide index --- docs/docs/user-guide/index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/docs/user-guide/index.md b/docs/docs/user-guide/index.md index f5d1ac5f3..4b41026c0 100644 --- a/docs/docs/user-guide/index.md +++ b/docs/docs/user-guide/index.md @@ -23,3 +23,6 @@ Here is a brief overview of the User Guide sections: EasyDiffraction in Python or Jupyter notebooks. - [Analysis Workflow](analysis-workflow/index.md) – Breaks down the data analysis pipeline into practical, sequential steps. +- [Reliability Factors](analysis-workflow/reliability-factors.md) – + Defines the equations and interpretation of the reported fit-quality + metrics.