Skip to content

docs:prerequisite the need for a separate database for Plane AI and clarify environment variable setup#244

Merged
danciaclara merged 3 commits intomasterfrom
add-db-prerequisite-in-ai-doc
Mar 16, 2026
Merged

docs:prerequisite the need for a separate database for Plane AI and clarify environment variable setup#244
danciaclara merged 3 commits intomasterfrom
add-db-prerequisite-in-ai-doc

Conversation

@akshat5302
Copy link
Member

@akshat5302 akshat5302 commented Mar 16, 2026

Description

This pull request updates the Plane AI self-hosting documentation to clarify database requirements.

Type of Change

  • Documentation update

Summary by CodeRabbit

  • Documentation
    • Clarified Plane AI setup to require a separate, dedicated database for AI data (e.g., chat history) to ensure isolation.
    • Added explicit guidance at prerequisites and enablement steps describing how to configure the database and set the related environment variable, with references to environment configuration guidance.
    • Repeated key guidance at critical setup points for visibility.

@vercel
Copy link

vercel bot commented Mar 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
developer-docs Ready Ready Preview, Comment Mar 16, 2026 8:30am

Request Review

@coderabbitai
Copy link

coderabbitai bot commented Mar 16, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 43c4cc89-d8b2-4665-8b39-3ca3d3c204fd

📥 Commits

Reviewing files that changed from the base of the PR and between 8e354bd and 17ccf8c.

📒 Files selected for processing (1)
  • docs/self-hosting/govern/plane-ai.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/self-hosting/govern/plane-ai.md

📝 Walkthrough

Walkthrough

Adds explicit information blocks stating Plane AI must use a separate, dedicated database in two locations (prerequisites and Enable Plane AI services). Blocks describe isolation of AI data (e.g., chat history), instruct setting PLANE_PI_DATABASE_URL, and reference the environment variables guide. No logic changes.

Changes

Cohort / File(s) Summary
Documentation Update
docs/self-hosting/govern/plane-ai.md
Added information blocks in prerequisites and Enable Plane AI services sections indicating Plane AI requires a separate dedicated database; details on isolating AI data, setting PLANE_PI_DATABASE_URL, and linking the environment variables guide.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 In tunnels of docs where the guidance does play,
I nudge a small note — keep AI data away.
A separate safe hutch, set PLANE_PI_DATABASE_URL right,
So chat logs and memories sleep tidy at night. ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding prerequisite documentation about the separate database requirement for Plane AI and clarifying environment variable setup.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add-db-prerequisite-in-ai-doc
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

akshat5302 and others added 2 commits March 16, 2026 13:58
Corrected formatting of the note about database isolation for Plane AI.
@danciaclara danciaclara merged commit 97c6ad4 into master Mar 16, 2026
8 checks passed
@danciaclara danciaclara deleted the add-db-prerequisite-in-ai-doc branch March 16, 2026 08:36
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.

2 participants