fix: text-to-sql devnote date, images, and publish-devnotes nav#546
fix: text-to-sql devnote date, images, and publish-devnotes nav#546andreatgretel merged 1 commit intomainfrom
Conversation
- Update post date from 2026-03-11 to 2026-04-14 so it appears as the newest post on the devnotes page. - Replace raw <img> tags with markdown image syntax so mkdocs rewrites relative paths correctly for the blog plugin's slug-based URLs. - Overlay mkdocs.yml from HEAD in publish-devnotes workflow so new nav entries are included in devnotes-only rebuilds.
|
Docs preview: https://62d5fea4.dd-docs-preview.pages.dev
|
Greptile SummaryThis PR fixes three real bugs with the text-to-sql devnote: the post date is corrected to
|
| Filename | Overview |
|---|---|
| .github/workflows/publish-devnotes.yml | Adds a pip install yq + two-command yq patch to overlay the "Dev Notes" nav from HEAD's mkdocs.yml onto the old-source checkout; logic is correct and uses Python yq's jq syntax appropriately. |
| docs/devnotes/posts/text-to-sql.md | Date corrected to 2026-04-14, two raw <img> tags converted to mkdocs markdown syntax, LiveSQLBench URL updated, and stale cross-reference links removed from the Key Resources section. |
Sequence Diagram
sequenceDiagram
participant GH as GitHub Actions
participant Git as Git (local)
participant yq as yq (Python)
participant Mike as mike deploy
GH->>Git: checkout SOURCE_SHA (last deployed)
GH->>Git: checkout github.sha -- docs/devnotes/
GH->>yq: pip install yq
GH->>Git: git show github.sha:mkdocs.yml
Git-->>yq: mkdocs.yml content (HEAD)
yq-->>GH: DEVNOTES_NAV (JSON of Dev Notes entries)
GH->>yq: yq -y -i patch old mkdocs.yml with DEVNOTES_NAV
yq-->>Git: mkdocs.yml updated in working tree
GH->>Mike: mike deploy --push (SOURCE_SHA tree + new devnotes + patched nav)
Reviews (2): Last reviewed commit: "fix: text-to-sql devnote date, images, a..." | Re-trigger Greptile
Code Review: PR #546 — fix: text-to-sql devnote date, images, and publish-devnotes navSummarySmall, well-scoped fix PR (2 files, +4/−8) that addresses three issues with the text-to-sql devnote published in #349:
Findingsdocs/devnotes/posts/text-to-sql.md
.github/workflows/publish-devnotes.yml
Observation (out of scope)
VerdictApprove. All three fixes are correct, well-motivated, and low-risk. The PR is cleanly scoped and the description clearly explains the rationale for each change. |
a333a9c to
a34de99
Compare
…IA-NeMo#546) - Update post date from 2026-03-11 to 2026-04-14 so it appears as the newest post on the devnotes page. - Replace raw <img> tags with markdown image syntax so mkdocs rewrites relative paths correctly for the blog plugin's slug-based URLs. - Overlay mkdocs.yml from HEAD in publish-devnotes workflow so new nav entries are included in devnotes-only rebuilds.
Summary
Fixes three issues with the text-to-sql devnote published in #349, and a nav bug in the
publish-devnotesworkflow.Changes
Fixed
2026-03-11to2026-04-14so the text-to-sql post appears at the top of the devnotes page instead of buried below older posts<img>tags with markdown![]()syntax - mkdocs rewrites relative paths for markdown images but not raw HTML, so the images were 404ing at the slug-based post URLpublish-devnotesworkflow now overlaysmkdocs.ymlfrom HEAD (not justdocs/devnotes/) so new nav entries are included in devnotes-only rebuildsGenerated with AI