Skip to content

Commit 5e3ea2a

Browse files
Reorganize reliability factors documentation (#225)
* Reorganize reliability factors documentation * Add reliability factors to User Guide index
1 parent c448b70 commit 5e3ea2a

3 files changed

Lines changed: 5 additions & 3 deletions

File tree

docs/docs/user-guide/analysis-workflow/reliability-factors.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Reliability Factors
3-
icon: material/chart-bell-curve-cumulative
43
---
54

6-
# :material-chart-bell-curve-cumulative: Reliability Factors
5+
# Reliability Factors
76

87
EasyDiffraction reports several complementary measures of agreement
98
between observed and calculated diffraction data. They are ratios

docs/docs/user-guide/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,6 @@ Here is a brief overview of the User Guide sections:
2323
EasyDiffraction in Python or Jupyter notebooks.
2424
- [Analysis Workflow](analysis-workflow/index.md) – Breaks down the data
2525
analysis pipeline into practical, sequential steps.
26+
- [Reliability Factors](analysis-workflow/reliability-factors.md)
27+
Defines the equations and interpretation of the reported fit-quality
28+
metrics.

docs/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,8 +222,8 @@ nav:
222222
- Structure: user-guide/analysis-workflow/model.md
223223
- Experiment: user-guide/analysis-workflow/experiment.md
224224
- Analysis: user-guide/analysis-workflow/analysis.md
225-
- Reliability Factors: user-guide/analysis-workflow/reliability-factors.md
226225
- Report: user-guide/analysis-workflow/report.md
226+
- Reliability Factors: user-guide/analysis-workflow/reliability-factors.md
227227
- Tutorials:
228228
- Tutorials: tutorials/index.md
229229
- Getting Started:

0 commit comments

Comments
 (0)