docs: document pipeline artifact contract and runtime outputs#93
Merged
fffoivos merged 1 commit intoeellak:developmentfrom Mar 23, 2026
Merged
Conversation
Collaborator
|
Thanks for the improvemetns @adidev001 |
Author
Thanks a lot for reviewing and merging this — really appreciate it! |
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.
Summary
This PR updates
docs/pipeline.mdto make the pipeline artifact layout a bit clearer and closer to the outputs contributors actually work with in practice.What changed
clean_markdown/to the artifact layout.processing_state.pklproblematic_files/andtimeout_files/docs/pipeline.mdandtests/test_pipeline_smoke.pyaligned when artifact paths changeWhy
While going through the docs and smoke tests during local setup, I noticed that some contributor-relevant runtime artifacts were reflected in tests and contribution notes, but not as clearly in the main pipeline layout documentation.
This change is meant to make that stage-level contract easier to follow for future contributors, especially when debugging pipeline runs or updating output paths.