Nest pipeline docs and add example configs page - #106
Merged
Conversation
…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/.
There was a problem hiding this comment.
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.ymlnav 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 viapymdownx.snippets. - Updated
pymdownx.snippetsconfiguration to setbase_pathand enablecheck_pathsso snippet includes are validated duringmkdocs 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
YAML_PIPELINE_GUIDE.md)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.mdembeds the six analysis-mode YAML files live viapymdownx snippets, so the docs track the real files in
examples/:static XES, time-resolved XES, 2D XAS, temporal XAS, droplet XES, RIXS.
Test
mkdocs buildwithcheck_paths: trueon snippets passes, so every includeresolves; spot-checked the built page to confirm the YAML renders.