Repository navigation
Add docs/tutorials index and move materials tutorial into it - #15
Merged
Merged
Conversation
Group end-to-end tutorials by application area: Markdown pages in docs/tutorials/<area>/, notebooks next to their scripts in applications/<area>/. Move the materials tutorial to docs/tutorials/material_science/ and fix its relative link, list it and the BioReason notebook in the new index and in docs/index.md, and add docs/tutorials/ to README, CONTRIBUTING and CHANGELOG. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
balajiadarsha
approved these changes
Oct 22, 2026
balajiadarsha
left a comment
Contributor
There was a problem hiding this comment.
The changes are limited to the documents and do not add, remove or modify functionality.
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.
Description
Adds
docs/tutorials/, one place to find PRISM's end-to-end tutorials, groupedby application area. Markdown pages go in
docs/tutorials/<area>/, where<area>is the application's directory underapplications/, or the name itwould take for an application with no scripts there yet. Notebooks stay in
applications/<area>/, next to the scripts they run, and the index links tothem there.
docs/materials_prism_tutorial.md(docs: add materials PRISM training tutorial #6) moves todocs/tutorials/material_science/materials_prism_tutorial.md. Its relativelink to the materials guide is updated for the new depth.
docs/tutorials/README.mdlists each tutorial with its modalities andplatform, links the BioReason notebook (bioreason-demo: PRISM-BioReason KEGG demo (SFT, GRPO, eval, notebook) #4) where it lives in
applications/bioreason/, and says where a new tutorial goes.docs/index.mdgains a Tutorials section. README, thedocs/layout table inCONTRIBUTING, and CHANGELOG point to the new folder.
Three tutorials still in flight are built on this branch. Each has this commit
merged in, plus a commit that moves its pages into the new layout and adds its
rows to the two index tables:
astroprism-implementationdocs/tutorials/astroprism/sww/vlm-demo-docsdocs/tutorials/vision_language/scits-demodocs/tutorials/timeseries/, with the notebook inapplications/timeseries/Please merge with "Create a merge commit", not squash or rebase. The three
branches above contain this branch's commit through a merge. A merge commit
keeps that commit in main's history, so each of them still merges cleanly on
top of it. Squash and rebase both land a copy with a new SHA, and then all three
conflict with main in
docs/index.mdanddocs/tutorials/README.md. Bothoutcomes were simulated with
git merge-treeagainst each branch.Type of Change
Compatibility
src.*import pathsprismCLI surfaceOne URL moves:
docs/materials_prism_tutorial.mdbecomesdocs/tutorials/material_science/materials_prism_tutorial.md. Nothing in therepository links to the old path; links to it from outside will break.
How Has This Been Tested?
The two pytest failures fail the same way on main in the same environment and
pass in main's CI:
test_every_tracked_python_file_is_visible_to_ruffandtest_intern_s2_input_preset_requires_its_encoder_implementation.frameworks/2026.1.0, Python 3.12.changes only Markdown. CI runs both.
New Dependencies, Data, or Assets
None.
Checklist
(see SECURITY.md)
No new tests: the change is Markdown only, and the required
doc_linksjobalready checks every link this PR adds or moves. The two local test failures
above fail the same way on main.
AI/LLM Assistance
Unticked pending a human read.
Additional Context
sww/vlm-demo-docsandscits-demoboth add rows after the materials row indocs/index.mdanddocs/tutorials/README.md, so whichever of them mergessecond will conflict there. Keep both sets of rows, time series before vision
language, so both tables stay in alphabetical order by area.
🤖 Generated with Claude Code