Update pipeline documentation - #1697
Open
tteggelit wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request significantly expands and restructures the documentation regarding Ramble's pipelines and phases. It introduces a new pipelines.rst file detailing common workspace workflows, updates advanced_topics.rst with architectural overviews and phase graphs, integrates Graphviz diagrams to visualize these workflows, and updates Sphinx configuration settings. The review feedback suggests minor grammatical and phrasing corrections to improve readability, such as removing a redundant "below", correcting "usecases" to "use cases", and adding a missing article.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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.
This:
conf.pyfor graphviz to remove global rank direction and sets the fonts to something less Mac specificAttaching PDFs of the new pages to make it a bit easier to see the results without people needing to checkout my branch and run Sphinx against it.
Basics - Pipelines and Phases.pdf
Advanced - Pipelines and Builtins.pdf