Onboarding guide - #3748
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…view Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
🧠 Redis MemoryFound 2 related items from repository history:
Memory updated at b18143a |
dwdougherty
left a comment
dwdougherty
left a comment
There was a problem hiding this comment.
A few changes to start...
| | Internal link | `{{</* relref "/operate/rc/page-name" */>}}` | | ||
| | Info callout | `{{</* note */>}} ... {{</* /note */>}}` | | ||
| | Warning callout | `{{</* warning */>}} ... {{</* /warning */>}}` | | ||
| | Tabbed content | `{{</* multitabs id="..." tab1="..." tab2="..." */>}}` | | ||
| | Embed a shared partial | `{{</* embed-md "filename.md" */>}}` | | ||
| | Image card / tile link | `{{</* image-card */>}}` | |
There was a problem hiding this comment.
There shouldn't be any /* and */ character sequences in these shortcodes. Check entire doc for this, as I may have missed some.
Co-authored-by: David Dougherty <david.dougherty@redis.com>
Co-authored-by: David Dougherty <david.dougherty@redis.com>
Co-authored-by: David Dougherty <david.dougherty@redis.com>
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at 40e10bc |
Co-authored-by: David Dougherty <david.dougherty@redis.com>
Co-authored-by: David Dougherty <david.dougherty@redis.com>
Co-authored-by: David Dougherty <david.dougherty@redis.com>
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at dccdcf8 |
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at ff066a7 |
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at 0cc9014 |
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at 4c6315f |
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at c5c10f3 |
Co-authored-by: David Dougherty <david.dougherty@redis.com>
Co-authored-by: David Dougherty <david.dougherty@redis.com>
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at 376909e |
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at 46d3791 |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
| The set name is [set] and the step is [step]. | ||
| ``` | ||
|
|
||
| If the example doesn't exist in the client repos yet, add it to `local_examples/` in this repo as a temporary measure, then open PRs to each client library to add it there permanently. |
There was a problem hiding this comment.
local_examples omits rebuild step
Medium Severity
The guide says to add files under local_examples/ and later remove them after upstream merges, but never says to run make components or make serve so build/make.py can regenerate examples/ and data/examples.json.
Additional Locations (1)
Reviewed by Cursor Bugbot for commit 376909e. Configure here.
| | `difficulty` | Optional | `beginner` (default), `intermediate`, or `advanced` | | ||
| | `buildsUpon` | When needed | Comma-separated step IDs this example depends on (see below) | | ||
| | `lang_filter` | Optional | Show only specific language tabs, e.g., `"Python,Node.js"` — must match exact names from `config.toml` | | ||
| | `max_lines` | Optional | Cap the number of visible lines | |
There was a problem hiding this comment.
Missing prereq shortcode parameters
Medium Severity
The clients-example parameter table and data-type tutorial guidance cover buildsUpon only, with no mention of prereq or needs_prereq, which production tutorials use for interactive and external Try it behavior.
Additional Locations (1)
Reviewed by Cursor Bugbot for commit 376909e. Configure here.
|
|
||
| Here's the source material: | ||
| [paste release highlights, new commands, and capability changes] | ||
| ``` |
There was a problem hiding this comment.
Version page prompt skips index
Low Severity
The copy-paste prompt for creating a new what's-new version page does not include updating content/develop/whats-new/_index.md, even though the section above says the index lists version releases.
Reviewed by Cursor Bugbot for commit 376909e. Configure here.
andy-stark-redis
left a comment
andy-stark-redis
left a comment
There was a problem hiding this comment.
Some of these things are just minor suggestions but there are a few incorrect details (mainly to do with buildsUpon).
| ### Prompt: Map a ticket to affected docs | ||
|
|
||
| ``` | ||
| I have a new feature to document. Here's the ticket / spec: |
There was a problem hiding this comment.
Maybe suggest /docs:make-plan-from-jira-ticket here? It only really works if the ticket contains a detailed description, though, so maybe it's more trouble than it's worth?
Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com>
Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com>
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at fb2e197 |
Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com>
Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com>
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at f8ee863 |
Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com>
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at d0a6ba1 |
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at fe4f563 |
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at 317ae7f |
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at c9e5f28 |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using high effort and found 2 potential issues.
There are 5 total unresolved issues (including 3 from previous reviews).
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit c9e5f28. Configure here.
| | Warning callout | `{{</* warning */>}} ... {{</* /warning */>}}` | | ||
| | Tabbed content | `{{</* multitabs id="..." tab1="..." tab2="..." */>}}` | | ||
| | Embed a shared partial | `{{</* embed-md "filename.md" */>}}` | | ||
| | Image card / tile link | `{{</* image-card */>}}` | |
There was a problem hiding this comment.
Forbidden shortcode escape sequences
Medium Severity
The ONBOARDING.md guide includes shortcode examples with {{</* ... */>}} syntax. This isn't valid Hugo, so these examples render as literal text instead of executing. The /* and */ characters within the shortcode delimiters are extraneous.
Reviewed by Cursor Bugbot for commit c9e5f28. Configure here.
| Multiple dependencies: | ||
|
|
||
| ``` | ||
| {{< clients-example set="list_tutorial" step="advanced_ops" buildsUpon="lpush_rpush, lpop_rpop" >}} |
There was a problem hiding this comment.
Example references nonexistent step
Medium Severity
The sample shortcode uses set="list_tutorial" and step="advanced_ops", but no advanced_ops step exists in that example set anywhere in content/. Copying it yields empty client tabs and a Hugo warning for a missing example.
Reviewed by Cursor Bugbot for commit c9e5f28. Configure here.
3 participants
Note
Low Risk
Documentation-only addition with no build, site, or application code changes.
Overview
Adds
ONBOARDING.md, a long-form docs contributor guide aimed at engineers using Claude Code in this repo.It introduces a
content/product map (Cloud, Software, RDI, Kubernetes, develop/integrate areas) and a four-step workflow (analyze → write → submit withmake serve→ review via/docs:assess-commentsand/docs:bugbot), with ready-to-paste prompts for common edits.The guide also documents repo-specific conventions: client library paths,
clients-example/local_examples/ external doctests, command pages (cmd_tools.py,/docs:new-command-page), release notes layouts per product, data type and integration page patterns, Preview vs GA maturity expectations, Hugo shortcodes, and a pre-PR checklist (accuracy, Google style, reviewers). It points contributors to/docs:skills and #docs for help.Reviewed by Cursor Bugbot for commit c9e5f28. Bugbot is set up for automated code reviews on this repo. Configure here.