DX-2866: inline start-redis tip so llms.txt includes its content - #763
Open
CahidArda wants to merge 10 commits into
Open
DX-2866: inline start-redis tip so llms.txt includes its content#763CahidArda wants to merge 10 commits into
CahidArda wants to merge 10 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR ensures the “start-redis” guidance is present as inline content (instead of a referenced snippet) so published markdown and LLM-facing exports (llms.txt / llms-full.txt) include the full text.
Changes:
- Replaced
<Snippet file="redis/start-redis-snippet.mdx" />with an inline<Tip>across multiple Redis docs and quickstarts. - Added the same tip content to additional Redis pages (e.g., “Connect with @upstash/redis” and “REST API”) and expanded agent-facing docs (MCP/CLI) with free-Redis guidance.
- Updated the llms build preamble and regenerated
llms.txt/llms-full.txt; removed the now-unused snippet file.
Reviewed changes
Copilot reviewed 37 out of 37 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| redis/sdks/ts/getstarted.mdx | Inline <Tip> replaces snippet reference so exported markdown includes the full content. |
| redis/sdks/py/gettingstarted.mdx | Inline <Tip> replaces snippet reference so exported markdown includes the full content. |
| redis/quickstarts/vercel-python-runtime.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/vercel-functions-pages-router.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/vercel-functions-app-router.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/supabase.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/sst-v2.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/python-aws-lambda.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/nextjs-pages-router.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/nextjs-app-router.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/laravel.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/koyeb.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/ion.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/google-cloud-functions.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/fly.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/flask.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/fastlycompute.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/fastapi.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/elixir.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/django.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/digitalocean.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/deno-deploy.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/cloudflareworkers.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/azure-functions.mdx | Inline <Tip> replaces snippet reference. |
| redis/quickstarts/aws-lambda.mdx | Inline <Tip> replaces snippet reference. |
| redis/overall/getstarted.mdx | Inline <Tip> replaces snippet reference in the main Redis getting started page. |
| redis/howto/connect-with-upstash-redis.mdx | Adds the inline <Tip> to ensure visibility in exports. |
| redis/howto/connect-client.mdx | Adds the inline <Tip> to ensure visibility in exports. |
| redis/features/restapi.mdx | Adds the inline guidance inside the existing <Tip> block. |
| redis/features/globaldatabase.mdx | Inline <Tip> replaces snippet reference. |
| llms/src/build.ts | Inlines the llms preamble content instead of loading it from _snippets/. |
| llms.txt | Regenerated output to include expanded preamble content. |
| llms-full.txt | Regenerated output to include expanded preamble content and added agent/CLI guidance. |
| devops/developer-api/openapi.yml | Adds the free-Redis guidance to the “Create Redis Database” endpoint description. |
| agent-resources/mcp.mdx | Adds tip + example prompt for starting a free Redis DB via MCP/tooling. |
| agent-resources/cli.mdx | Documents unauthenticated upstash start-redis and clarifies output format. |
| _snippets/redis/start-redis-snippet.mdx | Deletes the now-unused snippet file. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… trailing whitespace
Flattens the [`url`](url) markdown link to a bare URL across the Redis docs, the developer API description, and the agent-resources pages, so every surface matches the llms preamble. Mintlify autolinks bare URLs, so the rendered pages still link out.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The start-redis tip was included via a shared
<Snippet>component, but the generatedmarkdown / llms.txt output only contained a link to the snippet file instead of its
content. This inlines the tip directly on every page that used it, and adds it to the
"Connect with @upstash/redis" and "REST API" pages, so LLM-facing exports carry the
full text.
Changes
<Snippet file="redis/start-redis-snippet.mdx" />with the inline<Tip>on all 27 pages that used it (Redis overview/getstarted, features, quickstarts, TS/Python SDK getting-started pages)redis/howto/connect-with-upstash-redis.mdxandredis/features/restapi.mdx_snippets/redis/start-redis-snippet.mdx