docs: add explanatory markdown to example notebooks - #191
Merged
Conversation
The example notebooks under example_workflows/ had almost no prose, only code cells, which made the documentation hard to follow for new users. Add markdown cells explaining each workflow engine, what each step of the notebook does, and how the "Load Workflow with X" sections demonstrate interoperability, without changing any existing code cell. Also expand documentation/evcurve.md and documentation/nfdi.md (which were a few sentences each) to walk through the workflow.py functions and workflow.json structure the same way documentation/arithmetic.md already did, and lightly extend intro.md/conclusion.md. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
1 participant
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.
The example notebooks under example_workflows/ had almost no prose, only code cells, which made the documentation hard to follow for new users. Add markdown cells explaining each workflow engine, what each step of the notebook does, and how the "Load Workflow with X" sections demonstrate interoperability, without changing any existing code cell.
Also expand documentation/evcurve.md and documentation/nfdi.md (which were a few sentences each) to walk through the workflow.py functions and workflow.json structure the same way documentation/arithmetic.md already did, and lightly extend intro.md/conclusion.md.