Skip to content

DOC-6435 polish initial use cases#3013

Open
andy-stark-redis wants to merge 5 commits intomainfrom
DOC-6435-polish-init-use-cases
Open

DOC-6435 polish initial use cases#3013
andy-stark-redis wants to merge 5 commits intomainfrom
DOC-6435-polish-init-use-cases

Conversation

@andy-stark-redis
Copy link
Copy Markdown
Contributor

@andy-stark-redis andy-stark-redis commented Apr 10, 2026

Note: several skeleton use case examples are in place but only the session store landing page and it's Python implementation are in the proposed final format. I'll get the other pages into shape when we're happy with the sample session store pages.

This provides some use case examples with runnable code demos for all the main client libraries. Some points to note:

  • The landing page for the use case is based on the outline given in the Confluence page. However, checking this with LLMs suggested that the format needs tweaking a bit. However, if it's considered very important to stick to the template suggested in Confluence then I'll go back to that.
  • There are no examples for hiredis (no real API) and ioredis (we don't recommend it for new projects) but I'll add those in if we think they would still be useful.
  • The example code is deliberately minimal and uses Redis plus standard libraries only. If we want more examples of integrations with third party libraries then let me know.

All feedback is welcome, especially about the general integration of the code with the main use case info.


Note

Low Risk
Docs-only updates that expand and restructure the session store use-case content; risk is limited to navigation/SEO and potential wording regressions.

Overview
Improves the use-cases docs IA and session-store narrative. The use-cases index now hides list links and simplifies the displayed list items, and the session-store landing page is rewritten/expanded with clearer sections (when to use, why it’s hard, expected outcomes, how Redis helps, ecosystem) plus a reorganized list of code examples.

Refines per-language session-store example pages and the Python example content. Example pages update frontmatter (notably linkTitle/titles and the .NET description) for consistent labeling. The redis-py session-store guide is enhanced to document TTL, describe reserved fields explicitly, and update examples to use WATCH/MULTI/EXEC for atomic TTL refresh, while adding documented helper operations like update_session, set_session_ttl, get_ttl, and delete_session.

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

@andy-stark-redis andy-stark-redis requested review from a team, mortensi and ollopaci April 10, 2026 13:59
@andy-stark-redis andy-stark-redis self-assigned this Apr 10, 2026
@andy-stark-redis andy-stark-redis added do not merge yet clients Client library docs AI-friendliness Features that help AI tools understand and use the doc pages more easily. labels Apr 10, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 10, 2026

DOC-6435

@jit-ci
Copy link
Copy Markdown

jit-ci bot commented Apr 10, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ 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 1e025e8. Configure here.

Copy link
Copy Markdown
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

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

LGTM.

@andy-stark-redis
Copy link
Copy Markdown
Contributor Author

@dwdougherty Thanks for reviewing this (again!) Hopefully won't change too much more :-)

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

Labels

AI-friendliness Features that help AI tools understand and use the doc pages more easily. clients Client library docs do not merge yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants