Adds the full end-to-end tutorial, and refactors docs #41
Conversation
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
Updates documentation to be more useful and easier to find information.
merschformann
approved these changes
Dec 19, 2025
Member
merschformann
left a comment
merschformann
left a comment
There was a problem hiding this comment.
Nice work, thank you! ❤️
Corrects a typo in the documentation.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive end-to-end tutorial for orchestrating multiple decision models using Nextpipe and refactors the documentation structure for better organization.
Key Changes:
- Adds a new tutorial "Orchestrate multiple models" showing how to build a complete workflow from scratch using a Gurobi avocado price optimization example
- Moves conceptual documentation from tutorials/getting-started.md to the main index.md for better discoverability
- Reorganizes echo app documentation from tutorials to reference section
- Updates version dependencies (nextmv ≥0.37.2, nextpipe to v0.5.0)
Reviewed changes
Copilot reviewed 12 out of 26 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Updates nextmv dependency to ≥0.37.2 |
| nextpipe/about.py | Bumps version to v0.5.0 |
| mkdocs.yml | Restructures navigation: moves echo apps to reference, adds new orchestration tutorial |
| docs/tutorials/orchestrate-multiple-models.md | New comprehensive tutorial covering regression, decision, and workflow apps (1986 lines) |
| docs/tutorials/getting-started.md | Removed (content moved to index.md) |
| docs/reference/echo.md | Minor terminology update (nextpipe → Nextpipe) |
| docs/reference/echo-multi.md | Minor terminology update (nextpipe → Nextpipe) |
| docs/index.md | Enhanced with concepts section moved from getting-started.md, updated examples |
| docs/examples/*.md | Updated references to point to reorganized documentation |
| README.md | Terminology consistency improvements |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| executes, feel free to skip this step. | ||
|
|
||
| The decision workflow is composed of one, or more, executables that solve | ||
| decision problems. Decision workflows are typically lightweight, meaning that |
There was a problem hiding this comment.
Spelling error: "lighweight" should be "lightweight".
| s = m.addVars( | ||
| R, name="s", lb=0 | ||
| ) # predicted amount of sales in each region for the given price | ||
| w = m.addVars(R, name="w", lb=0) # excess wasteage in each region |
There was a problem hiding this comment.
Spelling error: "wasteage" should be "wastage".
Suggested change
| w = m.addVars(R, name="w", lb=0) # excess wasteage in each region | |
| w = m.addVars(R, name="w", lb=0) # excess wastage in each region |
| s = m.addVars( | ||
| R, name="s", lb=0 | ||
| ) # predicted amount of sales in each region for the given price | ||
| w = m.addVars(R, name="w", lb=0) # excess wasteage in each region |
There was a problem hiding this comment.
Spelling error: "wasteage" should be "wastage".
Suggested change
| w = m.addVars(R, name="w", lb=0) # excess wasteage in each region | |
| w = m.addVars(R, name="w", lb=0) # excess wastage in each region |
| manage dependencies between these steps, and integrate with external | ||
| applications and solvers. | ||
|
|
||
| Decision workflows are typically lightweight, meaning that they are focused on |
There was a problem hiding this comment.
Spelling error: "lighweight" should be "lightweight".
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.
Adds the full end-to-end tutorial in a tutorials section, moved what was there into the overview and as reference material.