docs: replace TODO placeholders with real content and fix internal links#33940
docs: replace TODO placeholders with real content and fix internal links#33940Vamsi-klu wants to merge 1 commit into
Conversation
Salvaged the conflict-free docs subset from dagster-io#33263 onto current master as a focused, reviewable docs-only change. Replaces TODO/placeholder markers with valid prose, wires up PyObject API references, and corrects several internal links across the build/test guides and the GCP/Snowflake integration docs.
Greptile SummaryThis PR replaces TODO/placeholder markers with real prose, wires up
Confidence Score: 4/5Safe to merge after fixing one file where new content was appended below a TODO line rather than replacing it. In troubleshooting-components.md the bare TODO on line 8 was not removed when the new introductory paragraph was added — readers will see TODO as the first word of the page body. docs/docs/guides/build/components/building-pipelines-with-components/troubleshooting-components.md
|
| Filename | Overview |
|---|---|
| docs/docs/guides/build/components/building-pipelines-with-components/troubleshooting-components.md | New troubleshooting content added, but the bare TODO on line 8 was not removed — it renders as visible text immediately before the first paragraph. |
| docs/docs/guides/build/projects/workspaces/migrating-workspace-yaml.md | Good migration guide content added; bare TODO on line 9 still renders (flagged in previous review thread). |
| docs/docs/integrations/libraries/snowflake/reference.md | Duplicate paragraphs at lines 104-105, 133-134, and 157-158 where old TODO-comment lines were not removed (flagged in previous review thread); dedent="4" props added correctly. |
| docs/sphinx/sections/integrations/libraries/omni/dagster-omni.rst | TODO replaced with a working link, but uses a hardcoded absolute docs.dagster.io URL that won't resolve in local/staging builds. |
| docs/docs/guides/test/testing-partitioned-config-and-jobs.md | PyObject reference for JobDefinition.execute_in_process wired correctly; TODO comment removed. |
| docs/docs/guides/build/assets/asset-versioning-and-caching.md | TODO link for DataVersion replaced with a proper PyObject reference. |
| docs/docs/integrations/libraries/gcp/bigquery/reference.md | Stray trailing backtick in SQL code block removed; dedent=4 prop added to CodeExample; TODO comment removed. |
Reviews (2): Last reviewed commit: "docs: replace TODO placeholders with rea..." | Re-trigger Greptile
4a36b41 to
60a41a9
Compare
Split out from #33263 (which I'm closing in favor of this), per the earlier discussion about breaking that PR into smaller, focused pieces.
This is the conflict-free, docs-only subset rebased onto current master. It replaces TODO/placeholder markers with valid content, wires up PyObject API references, and fixes several internal links across the build/test guides and the GCP/Snowflake/Omni integration docs. Only changes that apply cleanly to current master are included; files master has since rewritten were left out to avoid clobbering newer content.
Changes (14 files):
All introduced links, anchors, and PyObject references were verified to resolve (docs build uses onBrokenLinks/onBrokenAnchors: 'throw'). The core-logic changes that were also in #33263 are intentionally excluded and can be raised separately as focused PRs.