Skip to content

DOC-7047: Migrate develop/clients/nodejs to render hooks - #3951

Merged
andy-stark-redis merged 1 commit into
mainfrom
DOC-7047-clients-nodejs
Sep 8, 2026
Merged

andy-stark-redis merged 1 commit into
mainfrom
DOC-7047-clients-nodejs

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Sep 8, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Converts content/develop/clients/nodejs/ (12 files, flat directory — no nested subdirectories) from the relref/callout shortcodes to the DOC-6909 render hooks, per the DOC-7047 rollout.
  • {{< relref ... >}} links unwrapped and rewritten to the canonical /content/<path>.md[#anchor] form (resolved by layouts/_default/_markup/render-link.html).
  • 7 {{< note >}} callouts (all plain type, no nesting, no custom titles) converted to > [!NOTE]-style blockquotes (resolved by layouts/_default/_markup/render-blockquote.html).
  • No percent-delimited {{% alert ... %}} shortcodes exist in this directory, so there was nothing to leave untouched for that known gap.
  • Uses the tooling from PR DOC-7047: Formalize DOC-6909 shortcode migration tooling #3937 (build/migrate_shortcode_links.py), which is not merged into this PR — it was pulled in as an untracked helper, used, then deleted before committing.

Test plan

  • Confirmed no {{< relref or {{< note/warning/tip/info/alert shortcodes remain in the directory.
  • Confirmed no percent-delimited {{% alert %}} shortcodes exist in the directory.
  • Confirmed no nested block-level shortcodes were mangled inside any converted blockquote (none were nested to begin with).
  • Reviewed blockquote formatting for all 7 callouts: correct > [!NOTE] header, > prefix on every line, blank lines preserved as bare >.
  • Spot-checked rewritten links resolve to real content files in /content/<path>.md or /content/<path>/_index.md form with anchors preserved.
  • Ran .claude/hooks/check_shortcode_paths.py --scan over the directory: 0 files with issues.
  • Full-site Hugo build verification (href-diff) is being run centrally by the ticket owner before merge — isolated worktrees here can't run the full Hugo build (gitignored generated deps like data/examples.json aren't present).

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only link and callout markup migration with no runtime or security impact; main risk is broken internal links if a canonical path is wrong.

Overview
DOC-7047 rollout for content/develop/clients/nodejs/: twelve markdown pages are updated so internal navigation and callouts use Hugo render hooks instead of shortcodes.

Links: Every {{< relref "..." >}} reference is replaced with canonical /content/... paths (.md or _index.md, anchors preserved) for render-link.html.

Callouts: Seven plain {{< note >}} blocks become GitHub-style > [!NOTE] blockquotes for render-blockquote.html (client-side caching, SCH, query dialect notes, etc.).

No application or client-library code changes; clients-example / jupyter-example shortcodes are untouched.

Reviewed by Cursor Bugbot for commit 12dca5b. Bugbot is set up for automated code reviews on this repo. Configure here.

Continues the DOC-6909 rollout to nodejs: relref -> plain link -> canonical
/content/*.md form, and its note callouts -> `> [!NOTE]`-style blockquotes.

Converted all 12 files (flat directory, no nested subdirectories). 7
{{< note >}} callouts, all plain type, no nesting, no custom titles.
No percent-delimited {{% alert %}} shortcodes found in this directory.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 8, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7047

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 5 related items from repository history (5 new this commit):

Memory updated at 12dca5b

@andy-stark-redis

Copy link
Copy Markdown
Contributor Author

Central build verification (DOC-7047): built this branch merged onto main alongside the rest of this batch, diffed rendered hrefs against a clean main build with build/diff_rendered_hrefs.py — 0 href differences, 0 new build warnings (17 pre-existing warnings identical on both sides, all unrelated to this change).

@dwdougherty dwdougherty left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM. N.B. I didn't test every link - just a few here and there.

@andy-stark-redis

Copy link
Copy Markdown
Contributor Author

@dwdougherty Yeah, I wouldn't expect you to check each one :-) Thanks for the review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants