mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
Markus Ecker
7aa5b38755
## Summary
Adds a closed-beta user memory section to the self-hosted Intelligence
docs (no new pages, no nav changes — inline addition to the existing
`self-hosting.mdx` snippet).
- A short public `<Callout>` in `## What is this?` announces the
capability and points readers at the gated configuration sub-section
below. No implementation details exposed publicly.
- A password-gated `### User memory (closed beta)` sub-section in `##
Configuration reference` describes the user-visible effect, the scope
guarantees (per-user, per-org, per-project, read-only), and the two
flips to enable it:
- `app-api`: `appApi.env: [{ name: SL_ENABLED, value: "true" }]` in
`values.yaml`
- runtime / BFF: `mcpServer: true` on the `CopilotKitIntelligence`
constructor in `@copilotkit/runtime/v2`
- Includes a `runtime.ts` code snippet.
Heading sits outside the gate so readers see "User memory (closed beta)"
in the TOC; only the body is behind the password.
## Implementation notes
- Uses the existing `<InsecurePasswordProtected>` MDX component already
registered on both `(home)` and `integrations` routes — no new
infrastructure.
- Password is hardcoded as `cpki-mem-beta` on the prop. Reviewer choice:
keep as-is, swap to a new `NEXT_PUBLIC_*` env var, or reuse the existing
`NEXT_PUBLIC_LGC_DOCS_PASSWORD` (which would share access with the
LangGraph Cloud beta group).
- Locally bypassable when the env-var default is empty, which is the
same posture as Threads' existing precedent.
## Test plan
- [ ] Open `/premium/self-hosting` — verify the public Callout renders
in "What is this?" and the section anchor link works.
- [ ] Scroll to Configuration reference → after "Realtime gateway
(additional keys)" — verify the gate panel shows.
- [ ] Enter `cpki-mem-beta` — verify the SL_ENABLED table + `runtime.ts`
snippet reveal.
- [ ] Confirm the heading "User memory (closed beta)" is visible to
non-authenticated readers (sits outside `<InsecurePasswordProtected>`).
fumadocs-test
This is a Next.js application generated with Create Fumadocs.
Run development server:
npm run dev
# or
pnpm dev
# or
yarn dev
Open http://localhost:3000 with your browser to see the result.
Learn More
To learn more about Next.js and Fumadocs, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
- Fumadocs - learn about Fumadocs
Vercel Deployment with Git LFS
Docs assets are tracked with Git LFS. To ensure production builds always receive
real asset bytes (not pointer files), deploy docs through GitHub Actions using
.github/workflows/deploy_docs_vercel.yml.
Required GitHub repository secrets:
VERCEL_TOKENVERCEL_ORG_IDVERCEL_PROJECT_ID_DOCS
PR previews:
.github/workflows/deploy_docs_vercel_preview.ymldeploys docs previews for non-fork pull requests.- The workflow posts/updates a sticky PR comment with a clickable
Open Docs Previewlink.
Recommended Vercel project setting:
- Disable automatic Git-based deployments for the docs project and let the GitHub Actions workflow handle production deploys.