Skip to content

Nest pipeline docs and add example configs page - #106

Merged
lg345 merged 1 commit into
masterfrom
docs/pipeline-nav-examples
Jul 17, 2026
Merged

Nest pipeline docs and add example configs page#106
lg345 merged 1 commit into
masterfrom
docs/pipeline-nav-examples

Conversation

@lg345

@lg345 lg345 commented Jul 17, 2026

Copy link
Copy Markdown
Owner

What changed

Restructures the nav so everything about the YAML pipeline lives under one
section, and adds a page showing the full config for each analysis mode.

New "YAML pipeline" nav section, with children:

  • Guide (YAML_PIPELINE_GUIDE.md)
  • Example configs (new)
  • Step reference (Overview + four category pages)
  • Source (Model / Controller / Analysis steps)

The old top-level "Step reference" and "Source (YAML pipeline)" sections are
folded in here. The notebook getting-started pages move to a "Getting started"
section (renamed from "Examples" to avoid clashing with the new configs page).

docs/example_configs.md embeds the six analysis-mode YAML files live via
pymdownx snippets, so the docs track the real files in examples/:
static XES, time-resolved XES, 2D XAS, temporal XAS, droplet XES, RIXS.

Test

mkdocs build with check_paths: true on snippets passes, so every include
resolves; spot-checked the built page to confirm the YAML renders.

…gs page

Group the guide, a new Example configs page, the step reference, and the
source-linked API under one "YAML pipeline" nav section. The example configs
page embeds the six analysis-mode YAML files live via snippets, so the docs
track the real files in examples/.
Copilot AI review requested due to automatic review settings July 17, 2026 07:56
@lg345
lg345 merged commit 2994ec7 into master Jul 17, 2026
1 check passed
@lg345
lg345 deleted the docs/pipeline-nav-examples branch July 17, 2026 07:57

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR restructures the MkDocs navigation to group all YAML pipeline documentation under a single “YAML pipeline” section, and adds a new documentation page that embeds complete example pipeline YAML configurations directly from the repo’s examples/ directory.

Changes:

  • Reorganized mkdocs.yml nav to nest guide, example configs, step reference, and source pages under a new “YAML pipeline” section, and renamed “Examples” to “Getting started”.
  • Added docs/example_configs.md, embedding six end-to-end pipeline YAML files via pymdownx.snippets.
  • Updated pymdownx.snippets configuration to set base_path and enable check_paths so snippet includes are validated during mkdocs build.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
mkdocs.yml Restructures the docs nav and configures snippet includes (with path checking) to support live-embedded example YAML files.
docs/example_configs.md New page that documents and embeds full pipeline configs for each supported analysis mode from examples/.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants