Skip to content

First interactive code example #2897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
paoloredis wants to merge 9 commits into
base: main
Choose a base branch
from
Open

First interactive code example #2897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5782890
First interactive code example
paoloredis Mar 17, 2026
42c842d
Hide KERNEL_NAME from code cell
paoloredis Mar 17, 2026
e91ad68
Fix selector mismatch
paoloredis Mar 17, 2026
bfb7944
Remove unused variable
paoloredis Mar 17, 2026
27e4055
Use eq instead of hasPrefix
paoloredis Mar 18, 2026
4a0d800
Use explicit self-closing
paoloredis Mar 18, 2026
3adb358
Drive shortcode config via data/examples.json as much as possible
paoloredis Mar 18, 2026
0bd9a00
Make components in build to generate examples.json before build
paoloredis Mar 18, 2026
893e88f
Add rate limiting
paoloredis Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,9 @@ jobs:
- name: Install dependencies
run: make deps

- name: Generate components
run: make components
Copy link

@cursor cursor bot Mar 18, 2026

Choose a reason for hiding this comment

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

Missing make components in setup_and_build_latest CI job

High Severity

The make components step was added to the matrix build jobs (kubernetes, rs, rdi, redisvl), but NOT to the setup_and_build_latest job which also builds the latest docs — including the redis-py page that now contains jupyter-example shortcodes. That shortcode calls errorf if data/examples.json (generated by make components) is missing, so the setup_and_build_latest job will fail at Hugo build time.

Fix in Cursor Fix in Web


- name: Build Kubernetes ${{ matrix.version }}
run: |
set -x
Expand Down Expand Up @@ -245,6 +248,9 @@ jobs:
- name: Install dependencies
run: make deps

- name: Generate components
run: make components

- name: Build RS ${{ matrix.version }}
run: |
set -x
Expand Down Expand Up @@ -320,6 +326,9 @@ jobs:
- name: Install dependencies
run: make deps

- name: Generate components
run: make components

- name: Build RDI ${{ matrix.version }}
run: |
set -x
Expand Down Expand Up @@ -395,6 +404,9 @@ jobs:
- name: Install dependencies
run: make deps

- name: Generate components
run: make components

- name: Build RedisVL ${{ matrix.version }}
run: |
set -x
Expand Down
22 changes: 22 additions & 0 deletions assets/css/index.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,28 @@ select {
@apply block;
}

/* Jupyter example toggle visibility - same pattern as codetabs */
/* When aria-expanded is not set (initial state), show all lines at full opacity */
/* This is the default state showing only the step code */

/* When aria-expanded="true", show full file with context lines dimmed */
.thebe-container > .panel[aria-expanded="true"] .full-file-view .highlight .chroma > code > .line:not(.hl),
.thebe-container > .panel[aria-expanded="true"] .full-file-view .highlight .chroma > .lntable .lntd code > .lnt,
.thebe-container > .panel[aria-expanded="true"] .full-file-view .highlight .chroma > .lntable .lntd code > .line:not(.hl) {
@apply opacity-60;
}

/* Ensure highlighted lines (current step) have full opacity when expanded */
.thebe-container > .panel[aria-expanded="true"] .full-file-view .highlight .chroma > code > .hl,
.thebe-container > .panel[aria-expanded="true"] .full-file-view .highlight .chroma > .lntable .lntd code > .hl {
opacity: 1 !important;
}

.thebe-container > .panel .highlight .chroma > code > .hl,
.thebe-container > .panel .highlight .chroma > .lntable .lntd code > .hl {
@apply bg-inherit;
}

.download-cards {
@apply space-y-6 lg:space-y-0 max-w-[47rem] lg:max-w-full mx-auto lg:mx-0 lg:grid grid-cols-2 gap-x-6 items-start mb-[3.25rem];
}
Expand Down
12 changes: 4 additions & 8 deletions content/develop/clients/redis-py/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,23 +48,19 @@ pip install redis[hiredis]

Connect to localhost on port 6379, set a value in Redis, and retrieve it. All responses are returned as bytes in Python. To receive decoded strings, set `decode_responses=True`. For more connection options, see [these examples](https://redis.readthedocs.io/en/stable/examples.html).

{{< clients-example set="landing" step="connect" lang_filter="Python" description="Foundational: Connect to a Redis server and establish a client connection" difficulty="beginner" >}}
{{< /clients-example >}}
{{< jupyter-example set="landing" step="connect" lang_filter="Python" description="Connect to a Redis server and establish a client connection" />}}

Store and retrieve a simple string.

{{< clients-example set="landing" step="set_get_string" lang_filter="Python" description="Foundational: Set and retrieve string values using SET and GET commands" difficulty="beginner" >}}
{{< /clients-example >}}
{{< jupyter-example set="landing" step="set_get_string" depends="connect" lang_filter="Python" description="Set and retrieve string values using SET and GET commands" />}}

Store and retrieve a dict.

{{< clients-example set="landing" step="hash_operations" lang_filter="Python" description="Foundational: Store and retrieve hash data structures using HSET and HGETALL" difficulty="beginner" >}}
{{< /clients-example >}}
{{< jupyter-example set="landing" step="hash_operations" depends="connect" lang_filter="Python" description="Store and retrieve hash data structures using HSET and HGETALL" />}}

Close the connection when you're done.

{{< clients-example set="landing" step="close" lang_filter="Python" description="Foundational: Properly close a Redis client connection to release resources" difficulty="beginner" >}}
{{< /clients-example >}}
{{< jupyter-example set="landing" step="close" depends="connect" lang_filter="Python" description="Close the Redis connection" no_output="true" />}}

## More information

Expand Down
Loading
Loading