Enhance demo UI feedback and update documentation for LLMs#101
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 16 minutes and 38 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughRefactors the bloom-filter demo to build result DOM nodes programmatically and adds two LLM-facing docs plus landing metadata updates (HTML links, robots.txt, sitemap lastmod and entries). Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
landing/robots.txt (1)
5-5: Non-standardLLMs:directive in robots.txt.The
LLMs:directive is not part of the official robots.txt specification (RFC 9309). Standard crawlers will ignore it, and there's no guarantee LLM crawlers will recognize it either — this is an emerging convention without formal standardization.The intent is good, but consider whether linking to
/llms.txtvia<link rel="alternate">in HTML (which you've done inindex.html) and sitemap entries are sufficient for discoverability without adding a non-standard directive here.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@landing/robots.txt` at line 5, Remove the non-standard "LLMs: https://passiveintent.dev/llms.txt" directive from robots.txt (the "LLMs:" line) because it's not part of RFC 9309; either delete that line or convert it into a commented note using "#" if you want to keep it for humans, and rely on the existing <link rel="alternate"> in index.html and sitemap entries for discoverability instead.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@landing/llms-full.txt`:
- Around line 80-98: Replace the invalid example that uses createIntentEngine,
threshold, and calibrate with the real public API: instantiate IntentManager (or
the createBrowserIntent factory) and pass only valid IntentManagerConfig options
such as storageKey, namespace, baselineMeanLL, baselineStdLL, smoothingAlpha,
and optional bloom/graph objects; update event handlers to subscribe to
'hesitation_detected' (not 'hesitation') and ensure manager.start() is used;
consult the IntentManagerConfig and IntentEventMap types to confirm the exact
config keys and the hesitation_detected event payload shape before updating the
example.
In `@landing/llms.txt`:
- Around line 35-37: The Vanilla JS Quick Start import is incorrect: replace the
non-existent export createIntentEngine with a real export such as IntentManager
(class) or createBrowserIntent (factory) so the example will import a valid
symbol; update the example import line and subsequent usage to instantiate via
new IntentManager(...) or createBrowserIntent(...) to match the chosen symbol
and avoid runtime import errors.
---
Nitpick comments:
In `@landing/robots.txt`:
- Line 5: Remove the non-standard "LLMs: https://passiveintent.dev/llms.txt"
directive from robots.txt (the "LLMs:" line) because it's not part of RFC 9309;
either delete that line or convert it into a commented note using "#" if you
want to keep it for humans, and rely on the existing <link rel="alternate"> in
index.html and sitemap entries for discoverability instead.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 68dd552a-8b87-4391-bfd6-db2ccaa65203
📒 Files selected for processing (6)
demo/src/main.tslanding/index.htmllanding/llms-full.txtlanding/llms.txtlanding/robots.txtlanding/sitemap.xml
There was a problem hiding this comment.
Pull request overview
This PR improves PassiveIntent’s LLM-oriented discoverability by adding dedicated plain-text documentation resources and advertising them via the landing site metadata, while also tightening DOM update safety in the Bloom filter demo UI.
Changes:
- Added LLM-readable documentation endpoints (
llms.txt,llms-full.txt) and linked them from the homepage, sitemap, and robots directives. - Updated
landing/sitemap.xmlandlanding/robots.txtto expose the new documentation resources to crawlers. - Refactored the Bloom filter demo result rendering to avoid
innerHTMLand use safe DOM node construction.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| landing/sitemap.xml | Adds sitemap entries for LLM docs and updates lastmod. |
| landing/robots.txt | Adds an LLMs: directive pointing to llms.txt. |
| landing/llms.txt | New concise LLM-facing summary doc. |
| landing/llms-full.txt | New expanded technical LLM-facing doc with examples and licensing notes. |
| landing/index.html | Adds <link rel="alternate"> references to the LLM docs. |
| demo/src/main.ts | Replaces innerHTML usage with replaceChildren + created elements for safer rendering. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…t and licensing clarity
This pull request introduces comprehensive improvements to PassiveIntent's LLM (Large Language Model) accessibility and documentation. It adds new LLM-friendly documentation files, updates the site metadata and sitemap to advertise these resources, and includes minor UI improvements in the Bloom filter demo for better DOM safety and clarity.
LLM Documentation & Discoverability:
llms.txt) and a detailed technical overview (llms-full.txt), providing AI tools and users with structured, accessible information about PassiveIntent's features, architecture, and licensing. [1] [2]landing/index.htmlto include<link rel="alternate">tags referencing the new LLM documentation files, improving discoverability by AI agents and search engines.landing/sitemap.xmlwith appropriate priorities, and updated the main page'slastmoddate.landing/robots.txtto include aLLMs:directive pointing tollms.txt, signaling to AI crawlers where to find LLM-specific content.Demo UI Improvements:
demo/src/main.ts) to usereplaceChildrenand DOM element creation instead of directly settinginnerHTML. This enhances security, prevents potential XSS issues, and improves maintainability.## DescriptionType of change
Checklist
npm run lintandnpm run typechecklocallynpm run test:unit -w @passiveintent/core)Summary by CodeRabbit
Documentation
Chores
Bug Fixes / UI