Skip to content

docs: prep for site#5096

Merged
abcxff merged 1 commit into
mainfrom
05-21-docs_prep_for_site
May 23, 2026
Merged

docs: prep for site#5096
abcxff merged 1 commit into
mainfrom
05-21-docs_prep_for_site

Conversation

@abcxff
Copy link
Copy Markdown
Contributor

@abcxff abcxff commented May 23, 2026

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@railway-app railway-app Bot temporarily deployed to rivet-frontend / rivet-pr-5096 May 23, 2026 01:22 Destroyed
@railway-app
Copy link
Copy Markdown

railway-app Bot commented May 23, 2026

🚅 Deployed to the rivet-pr-5096 environment in rivet-frontend

Service Status Web Updated (UTC)
frontend-cloud ✅ Success (View Logs) Web May 23, 2026 at 1:31 am
mcp-hub ✅ Success (View Logs) Web May 23, 2026 at 1:31 am
website 🕒 Building (View Logs) Web May 23, 2026 at 1:30 am
kitchen-sink ❌ Build Failed (View Logs) Web May 23, 2026 at 1:30 am
ladle ✅ Success (View Logs) Web May 23, 2026 at 1:24 am
frontend-inspector ❌ Build Failed (View Logs) Web May 23, 2026 at 1:23 am

@abcxff abcxff mentioned this pull request May 23, 2026
11 tasks
Copy link
Copy Markdown
Contributor Author

abcxff commented May 23, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@abcxff abcxff mentioned this pull request May 23, 2026
11 tasks
@abcxff abcxff marked this pull request as ready for review May 23, 2026 01:24
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 23, 2026

PR Review: docs: prep for site (#5096)

This PR adds a registry.listen() convenience method, an LLMOnly MDX component for agent-targeted docs, and a draft.md agent guide. A few issues worth addressing.


Bug -- LLMOnly content is stripped by the subsequent JSX cleaner (llms-full.txt.ts:21)

The comment on line 11 correctly notes that LLMOnly must unwrap before the JSX-with-children stripper. But in rivet-compute.mdx, the <LLMOnly> block sits inside a <Step> component. After unwrapping, the formerly-hidden content is now inside <Step>...</Step>, which the next regex pass immediately deletes.

The agent-monitoring instructions added in this PR will never appear in /llms-full.txt -- they are silently dropped by the Step stripper. The LLMOnly feature only works correctly when the block is not nested inside another uppercase JSX component. Either the JSX stripper needs to hoist LLMOnly contents out before stripping the parent, or docs authors must avoid nesting <LLMOnly> inside Steps.


Bug -- draft.md contains unexpanded JavaScript template literal placeholders

draft.md was added with raw template expressions that a JavaScript template engine was supposed to fill in. None are ever substituted. When a user copies the gh secret set command and runs it in bash, the shell expands unset variables to empty strings, overwriting secrets with empty values. The curl commands would hit empty URLs with empty auth headers. The ternary on runnerName is raw JS syntax never evaluated in markdown.


Issue -- listen() installs no signal handlers and discards closeServer

listen() uses handler() (Mode B / serverless path), which never calls #startEnvoy(). Signal handlers (SIGINT/SIGTERM for graceful actor shutdown) are only installed inside #startEnvoy(). The JSDoc and draft.md both document listen() as a standalone long-running server entry point, but:

  1. SIGINT/SIGTERM trigger an immediate process exit without draining in-flight actor operations or flushing state.
  2. The closeServer function returned by crossPlatformServe on Node.js is discarded. There is no way to close the bound port.

listen() should either call this.startEnvoy() or install its own shutdown hooks and hold a reference to closeServer.


Issue -- loadRuntimeServeStatic throws for unknown runtimes when publicDir is set

crossPlatformServe handles unknown runtimes by falling through to serveNode. loadRuntimeServeStatic does not apply the same fallback -- it throws for anything that is not node, bun, or deno. If detectRuntime() returns something unexpected, listen({ publicDir: "..." }) throws before the server starts. The fix is to apply the same default fallback in loadRuntimeServeStatic.


Nit -- LLMOnly component should declare children in its type

export const LLMOnly = () => null means any TypeScript file that imports and uses LLMOnly with children content will get a type error. The signature should be ({ children }: { children?: React.ReactNode }) => null.


Summary:

Severity Finding
High LLMOnly content inside Step is silently dropped by the JSX stripper in llms-full.txt.ts
High draft.md ships with unexpanded template placeholders; bash commands are broken and could overwrite secrets with empty values
Medium listen() has no signal handlers and discards closeServer -- no graceful shutdown path
Low loadRuntimeServeStatic throws for unknown runtimes when publicDir is set
Nit LLMOnly should declare children in its prop type

Generated with Claude Code

Copy link
Copy Markdown
Contributor Author

abcxff commented May 23, 2026

Merge activity

  • May 23, 1:25 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • May 23, 1:31 AM UTC: Graphite rebased this pull request as part of a merge.
  • May 23, 1:31 AM UTC: @abcxff merged this pull request with Graphite.

@abcxff abcxff changed the base branch from 05-21-chore_enable_rivet_compute_docs to graphite-base/5096 May 23, 2026 01:28
@abcxff abcxff changed the base branch from graphite-base/5096 to main May 23, 2026 01:29
@abcxff abcxff force-pushed the 05-21-docs_prep_for_site branch from 9efdc76 to 7efea73 Compare May 23, 2026 01:30
@railway-app railway-app Bot temporarily deployed to rivet-frontend / rivet-pr-5096 May 23, 2026 01:30 Destroyed
@abcxff abcxff merged commit cef217f into main May 23, 2026
13 of 18 checks passed
@abcxff abcxff deleted the 05-21-docs_prep_for_site branch May 23, 2026 01:31
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.

1 participant