Skip to content

Update pipeline documentation - #1697

Open
tteggelit wants to merge 4 commits into
GoogleCloudPlatform:developfrom
tteggelit:pipeline_docs
Open

Update pipeline documentation#1697
tteggelit wants to merge 4 commits into
GoogleCloudPlatform:developfrom
tteggelit:pipeline_docs

Conversation

@tteggelit

Copy link
Copy Markdown
Contributor

This:

  • Adds a new Basics section to introduce a typical Ramble workspace workflow and the concepts of pipelines and phases
  • Updates the Advanced section on pipelines with more information and diagrams to help explain the flow
  • Updates the docs conf.py for graphviz to remove global rank direction and sets the fonts to something less Mac specific

Attaching 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

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread lib/ramble/docs/dev_guides/advanced_topics.rst
Comment thread lib/ramble/docs/dev_guides/advanced_topics.rst Outdated
Comment thread lib/ramble/docs/pipelines.rst Outdated
tteggelit and others added 3 commits July 31, 2026 13:11
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant