Repository navigation
docs: add standalone Relayfile and Relayloop documentation sections - #5
Conversation
Add two self-contained documentation sections alongside the Agent Relay
docs, each with its own sidebar, multi-group nav, scoped search, and
markdown mirrors:
- /docs/file → Relayfile (17 pages)
- /docs/loop → Relayloop (13 pages)
Infrastructure:
- lib/product-docs-nav.ts: pure, client-safe section + nav definitions
- lib/product-docs.ts: server-only content loaders, markdown mirrors,
per-section search index
- DocsNav renders a distinct product sidebar (header, tagline, back-link,
own nav groups/icons) when under a product path
- DocsSearch scopes to the active product's index and routes within it
- routes under app/docs/{file,loop}/* (index redirect, [slug] page via a
shared ProductDocPage, markdown/[slug] endpoint)
- extracted the shared MDX component map to components/docs/mdx-components
Content is grounded in the relayfile/relayfile-cloud and
relayhistory/relayhistory-cloud repos.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
|
Warning Review limit reached
More reviews will be available in 40 minutes and 6 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (48)
✨ 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 |
|
Preview deployed!
This is a Cloudflare Workers preview version of this PR's build. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a0d9f4ab1e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| </div> | ||
| </article> | ||
| <aside className={styles.tocSidebar}> | ||
| <TableOfContents items={doc.toc} /> |
There was a problem hiding this comment.
When rendering /docs/file/* or /docs/loop/* at desktop widths, this still uses TableOfContents, which always renders the Agent Relay DocsVersionSelect. That selector is wired to the main docs paths; for example, changing versions on /docs/file/quickstart treats file as the docs slug and navigates to /docs/7.1.1/introduction, so the standalone product docs still expose a broken version switch even though the product sidebar hides it. Use a product-specific TOC or add an option to omit the version/language controls here.
Useful? React with 👍 / 👎.
|
|
||
| function HeadingWithId(level: 2 | 3) { | ||
| return function Heading({ children, ...props }: React.HTMLAttributes<HTMLHeadingElement>) { | ||
| const text = typeof children === 'string' ? children : String(children); |
There was a problem hiding this comment.
For headings that contain inline MDX nodes, such as the new ## \sync`sections inweb/content/docs/loop/cli.mdx, childrenis a React element/array rather than a plain string.String(children)becomes[object Object], so the rendered heading id becomes object-objectwhilegetDoc() generated TOC ids from the markdown text (sync`, etc.); the On this page links for those product CLI/API pages won't target their headings. Extract the text recursively before slugifying.
Useful? React with 👍 / 👎.
|
ℹ️ pr-reviewer: review only — no file changes were applied to the PR (nothing to commit after review). The notes below are advisory and were not pushed. PR #5 Review —
|
Relayfile: - Rewrite introduction around event materialization; CLI/SDK CodeGroup - Add events (webhook normalization) and self-hosting concept pages - why-files mirrors the "Just Give the Agent Files" blog, trimmed - quickstart shows hosted path only, links self-host + GitHub Relayloop: ground the docs in relayhistory/relayhistory-cloud - Remove the fabricated `ai-hist cloud` command group; real flow is `ai-hist login` + `ai-hist push`, plus pair check and learn distill - Rebuild CLI reference (pack/resume/export/import/tags, real env vars) - Add Grok source; correct cloud architecture to Workers + Neon/pgvector - Default tier is vendor-readable (scrubbed); E2E is Enterprise tier - Mark unbuilt cloud/team features (cross-device pull, web UI, hosted MCP, Insights, teams, pricing) as coming soon Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
loop still needs work, relayfile passable for now |
1 participant
Summary
Adds two standalone documentation sections alongside the existing Agent Relay docs — each with its own sidebar, multi-group navigation, scoped search, and markdown mirrors. They are separate doc sites, not entries in the Agent Relay nav.
/docs/file→ Relayfile (17 pages) — the event layer for AI agents/docs/loop→ Relayloop (13 pages) — the system of record for how a team works with AI agentsInfrastructure
lib/product-docs-nav.ts— pure, client-safe section + nav definitions (kept free ofnode:fsso the client sidebar can import it)lib/product-docs.ts— server-only content loaders, markdown mirrors, and per-section search indexDocsNavrenders a distinct product sidebar (product name, tagline, "← Agent Relay docs" back-link, own nav groups/icons) when under a product path; version selector hidden thereDocsSearchswitches to the active product's index and routes results within that sectionapp/docs/{file,loop}/*: index redirect,[slug]page via a sharedProductDocPage, and amarkdown/[slug]endpoint per pagecomponents/docs/mdx-componentsContent
Grounded in the
relayfile/relayfile-cloudandrelayhistory/relayhistory-cloudrepos:Verification
npm run buildgreen — all 17 + 13 pages prerendered as SSG, plus.mdmirrors and index redirectsnpx vitest run— 21/21 passNotes for review
relayfile,ai-hist). Therelayhistory-cloudbrand plan calls that product "Relay Trail" — easy to rename via thelabelinlib/product-docs-nav.ts+ content if preferred.relayhistory-cloud/docs/encryption.md, E2E is the Enterprise/Private tier while the default Team tier is vendor-readable;loop/privacy.mdxdescribes both honestly rather than claiming blanket E2E. Worth confirming it matches current positioning.🤖 Generated with Claude Code
Summary by cubic
Add two standalone docs sections for Relayfile (/docs/file, 19 pages) and Relayloop (/docs/loop, 13 pages), each with its own sidebar and scoped search. They live alongside the Agent Relay docs and include markdown mirrors.
New Features
[slug]pages via a sharedProductDocPage, andmarkdown/[slug]endpoints.ai-histflow (login+push), cloud architecture updated (Workers + Neon/pgvector), Grok source added, and privacy clarified (default vendor-readable; E2E is Enterprise). All pages prerendered as SSG.Refactors
lib/product-docs-nav.ts(client-safe section + nav) andlib/product-docs.ts(server loaders, markdown mirrors, per-section search index).components/docs/mdx-components; addedProductDocPage.DocsNavandDocsSearchto support product sections; version selector hidden on product pages.renderMarkdownBodyfor markdown mirrors.Written for commit cd571f2. Summary will update on new commits.