docs(platform): add data-model page + DB configuration for praisonai-platform#254
docs(platform): add data-model page + DB configuration for praisonai-platform#254MervinPraison wants to merge 1 commit intomainfrom
Conversation
…platform (fixes #251) - Add comprehensive data-model.mdx page with all 11 database entities - Include Mermaid ER diagram with standard color scheme - Document all configuration options and common patterns - Update getting-started.mdx with database configuration section - Update platform index.mdx with Data Model card - Add page to docs.json navigation under Platform features Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 57 minutes and 42 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✨ 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 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new 'Data Model' documentation page, detailing the database schema and configuration for the PraisonAI Platform, and integrates it into the existing documentation structure. I have reviewed the provided code snippet and suggest including the necessary imports and the FastAPI app initialization to improve the clarity and usability of the example for users.
| from fastapi import Depends | ||
| from praisonai_platform.api.deps import get_db | ||
|
|
||
| @app.get("/workspaces") | ||
| async def list_workspaces(session: AsyncSession = Depends(get_db)): |
There was a problem hiding this comment.
The FastAPI code snippet is missing the import for AsyncSession and the initialization of the app object. Including these makes the example more robust and easier for users to follow.
from fastapi import FastAPI, Depends
from sqlalchemy.ext.asyncio import AsyncSession
from praisonai_platform.api.deps import get_db
app = FastAPI()
@app.get("/workspaces")
async def list_workspaces(session: AsyncSession = Depends(get_db)):
Fixes #251
Summary
Key Features
Source Verification
All schema information was extracted directly from praisonai_platform/db/ source files including models.py, base.py, and deps.py for accurate documentation.
Generated with Claude Code