docs: clarify privacy and onboarding boundaries#104
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughThis pull request updates documentation across the repository to improve consistency, clarity, and flexibility. The changes standardize authentication placeholder syntax to 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/getting-started/quick-start.mdx`:
- Around line 40-42: The shell examples use an unquoted environment variable
(DATABASE_URL) which can break on special characters; update each psql
invocation and any other shell examples that reference DATABASE_URL so they use
"$DATABASE_URL" instead (e.g., change psql $DATABASE_URL -f scripts/setup-db.sql
to psql "$DATABASE_URL" -f scripts/setup-db.sql and similarly quote DATABASE_URL
in all other examples in quick-start.mdx).
In `@docs/guides/security-hardening.mdx`:
- Line 16: Update the absolute statement on auth in security-hardening.mdx so it
excludes the health endpoints; change the sentence that currently reads “All API
endpoints require the `Authorization: Bearer <your-token>` header.” to clarify
that all protected endpoints require the header while explicitly exempting
`/health`, `/health/live`, and `/health/ready` (or say “health endpoints”) as
unauthenticated. Ensure the new wording references those specific endpoints so
readers aren’t misled.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e825b3a6-5511-44fb-8d23-d018d6d3184c
📒 Files selected for processing (10)
README.mddocs/RUNBOOK.mddocs/getting-started/configuration.mdxdocs/getting-started/introduction.mdxdocs/getting-started/quick-start.mdxdocs/guides/cloud-run-deployment.mdxdocs/guides/security-hardening.mdxdocs/index.mdxinfra/cloud-tasks/README.mdinfra/gcs/README.md
Quote DATABASE_URL examples and clarify auth requirements for health endpoints.
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/getting-started/quick-start.mdx (1)
99-99: ⚡ Quick winConsider splitting this guidance into separate sentences or a list for clarity.
This sentence combines three distinct topics (data persistence, production security setup, and privacy consent) that might be easier to scan if separated.
♻️ Example refactor for scannability
-Imported documents, extracted memories, and conversation summaries remain in your configured database/storage until deleted. Set `API_BEARER_TOKEN`, restrict CORS for production, and avoid importing third-party/private data without consent. +Imported documents, extracted memories, and conversation summaries remain in your configured database/storage until deleted. + +For production deployments: + +- Set `API_BEARER_TOKEN` to restrict API access +- Configure CORS restrictions +- Avoid importing third-party or private data without consent🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/getting-started/quick-start.mdx` at line 99, The long sentence beginning "Imported documents, extracted memories, and conversation summaries remain..." bundles three separate guidance points (data persistence, production security, and privacy/consent); split it into separate sentences or a bulleted list so each topic is one clear line—specifically update the sentence in quick-start.mdx that starts with "Imported documents..." to either three concise sentences or a short list items: (1) where data is persisted, (2) set API_BEARER_TOKEN and restrict CORS in production, and (3) do not import third‑party/private data without consent.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/getting-started/quick-start.mdx`:
- Line 99: The long sentence beginning "Imported documents, extracted memories,
and conversation summaries remain..." bundles three separate guidance points
(data persistence, production security, and privacy/consent); split it into
separate sentences or a bulleted list so each topic is one clear
line—specifically update the sentence in quick-start.mdx that starts with
"Imported documents..." to either three concise sentences or a short list items:
(1) where data is persisted, (2) set API_BEARER_TOKEN and restrict CORS in
production, and (3) do not import third‑party/private data without consent.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 790824e1-8c42-4dbd-8c0d-40680ad3c000
📒 Files selected for processing (2)
docs/getting-started/quick-start.mdxdocs/guides/security-hardening.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/guides/security-hardening.mdx
Split persistence, security, and consent guidance after CodeRabbit follow-up.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
DATABASE_URL/ pgvector setup instead of service-role-key-first Supabase instructionsVerification
git diff --checkpnpm dlx markdownlint-cli2 README.md docs/RUNBOOK.md docs/getting-started/configuration.mdx docs/getting-started/introduction.mdx docs/getting-started/quick-start.mdx docs/guides/cloud-run-deployment.mdx docs/guides/security-hardening.mdx docs/index.mdx infra/cloud-tasks/README.md infra/gcs/README.mdNotes
pnpm install --frozen-lockfilewas not used because this VM hit disk pressure during Electron postinstall; targeted Markdown lint passed.