Skip to content

Conversation

codyde
Copy link
Contributor

@codyde codyde commented Aug 27, 2025

Introduces a new component that allows embedding hidden instructions for LLM/AI assistants within documentation. These instructions are invisible to users but preserved in HTML and markdown exports to help guide AI tools when working with the documentation.

Features

  • Hidden from visual display with comprehensive CSS hiding
  • Preserved in HTML for markdown conversion
  • Clean blockquote formatting in exports
  • Accessible via <LLMSteering> component in MDX

Files Added

  • src/components/llmSteering.tsx - The hidden markdown component
  • platform-includes/llm-steering/_default.mdx - Default LLM steering content
  • src/mdxComponents.ts - Component registration

🤖 Generated with Claude Code

Introduces a new component that allows embedding hidden instructions for LLM/AI
assistants within documentation. These instructions are invisible to users but
preserved in HTML and markdown exports to help guide AI tools when working with
the documentation.

Features:
- Hidden from visual display with comprehensive CSS hiding
- Preserved in HTML for markdown conversion
- Clean blockquote formatting in exports
- Accessible via <LLMSteering> component in MDX

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copy link

vercel bot commented Aug 27, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
develop-docs Ready Ready Preview Comment Aug 27, 2025 8:59pm
sentry-docs Ready Ready Preview Comment Aug 27, 2025 8:59pm

Revised critical guidelines for implementing Sentry with LLMs, emphasizing the necessity of user permission before executing examples from documentation and additional integrations. Enhanced clarity on the implementation of Breadcrumbs, reinforcing that it should only occur upon explicit user request.
@codyde codyde requested a review from nikolovlazar August 27, 2025 18:22
@codyde codyde marked this pull request as ready for review August 27, 2025 18:23
Copy link

codecov bot commented Aug 27, 2025

Bundle Report

Changes will increase total bundle size by 5.63kB (0.02%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 9.9MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 12.5MB 5.64kB (0.05%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
server/middleware-*.js -5.55kB 1.0kB -84.74%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
static/2tB67UBdV0BtfSn6flJnN/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/2tB67UBdV0BtfSn6flJnN/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/AuWgcKhLdF2zWrV8mGre1/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/AuWgcKhLdF2zWrV8mGre1/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.78MB -0.0%
../instrumentation.js -3 bytes 1.1MB -0.0%
9523.js -3 bytes 1.08MB -0.0%
../app/[[...path]]/page.js.nft.json 1.73kB 770.82kB 0.22%
../app/platform-redirect/page.js.nft.json 1.73kB 770.73kB 0.22%
../app/sitemap.xml/route.js.nft.json 1.73kB 768.21kB 0.23%
../app/[[...path]]/page.js 465 bytes 608.77kB 0.08%

Files in ../app/[[...path]]/page.js:

  • ./src/mdxComponents.ts → Total Size: 3.92kB

  • ./src/components/llmSteering.tsx → Total Size: 1.36kB

App Routes Affected:

App Route Size Change Total Size Change (%)
/[[...path]] 465 bytes 3.17MB 0.01%

Copy link
Member

@nikolovlazar nikolovlazar left a comment

Choose a reason for hiding this comment

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

Looks good!

@codyde codyde enabled auto-merge (squash) August 27, 2025 20:54
@codyde codyde changed the title Add LLMSteering component for hidden documentation instructions Add LLMSteering component for hidden LLM markdown instructions Aug 27, 2025
@codyde codyde merged commit 1ae2228 into master Aug 27, 2025
15 of 18 checks passed
@codyde codyde deleted the feat/llmsteering-hidden-markdown-v2 branch August 27, 2025 20:59
codyde added a commit that referenced this pull request Aug 28, 2025
…om/getsentry/sentry-docs into feat/python-docs-improvement-clean

* 'feat/python-docs-improvement-clean' of https://github.com/getsentry/sentry-docs:
  docs(replay): Bring replay nav item to all apple platforms (#14710)
  User Feedback Basics Page (#14670)
  Update AM3 and legacy billing for logs GA, DO NOT MERGE BEFORE LOGS GA (#14589)
  Add LLMSteering component for hidden documentation instructions (#14744)
  New data retention policy page (#14661)
  Adding error prediction to Prevent AI docs (#14641)
codyde added a commit that referenced this pull request Aug 28, 2025
…om/getsentry/sentry-docs into feat/nextjs-centralized-flow-clean

* 'feat/nextjs-centralized-flow-clean' of https://github.com/getsentry/sentry-docs:
  Fix reference to span in processOrderBatch function (#14741)
  chore(java): Add docs on how to use tracePropagationTargets (#14752)
  docs(replay): Bring replay nav item to all apple platforms (#14710)
  User Feedback Basics Page (#14670)
  Update AM3 and legacy billing for logs GA, DO NOT MERGE BEFORE LOGS GA (#14589)
  Add LLMSteering component for hidden documentation instructions (#14744)
  New data retention policy page (#14661)
  Adding error prediction to Prevent AI docs (#14641)
codyde added a commit that referenced this pull request Aug 29, 2025
* 'master' of https://github.com/getsentry/sentry-docs: (72 commits)
  docs(replay): Bring replay nav item to all apple platforms (#14710)
  User Feedback Basics Page (#14670)
  Update AM3 and legacy billing for logs GA, DO NOT MERGE BEFORE LOGS GA (#14589)
  Add LLMSteering component for hidden documentation instructions (#14744)
  New data retention policy page (#14661)
  Adding error prediction to Prevent AI docs (#14641)
  feat(logs): Remove beta note from logs docs (#14686)
  First pass at logs quota doc (#14671)
  docs(aws): Remove manual setup steps for ESM (#14738)
  Android Logs docs without Errors / Breadcrumbs distractions (#14733)
  chore(Unity): Dropped 2019 relevant section from Known Limitations (#14735)
  feat: Added Unity `UserFeedback` Prefab (#14667)
  chore(Unity): Added Mono & Line Numbers to Known Limitations (#14736)
  docs(js): Fix Next.js client tracing config (#14734)
  chore: Updated known limitation in Unity with Cysharp (#14666)
  feat(Unity ): Added `APK+OBB` initialization to troubleshooting (#14668)
  Codecov copy & screenshot edits (#14659)
  fix(cloudflare): Remove unused instrument.mjs from hono on cloudflare (#14723)
  update advanced scrubbing doc - adding logs section (#14696)
  fixing some errors from nextjs-source-map-updates branch (#14467)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants