Skip to content

Reorganize reliability factors documentation #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AndrewSazonov merged 2 commits into from
Sep 14, 2026
+5 −3
Merged

Reorganize reliability factors documentation #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
456199f
Reorganize reliability factors documentation
AndrewSazonov Sep 14, 2026
1bb1de8
Add reliability factors to User Guide index
AndrewSazonov Sep 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/docs/user-guide/analysis-workflow/reliability-factors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/user-guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading