docs: add comprehensive setup and rebranding guides
Add complete documentation suite for project setup, rebranding, and deployment:
- SETUP_GUIDE.md: Comprehensive local development setup for all platforms
- REBRANDING_GUIDE.md: Complete guide for customization and white-labeling
- QUICK_START_WINDOWS.md: Fast-start guide for Windows users
- PROJECT_OVERVIEW.md: Detailed architecture and feature analysis
- README_DOCUMENTATION.md: Navigation guide for all documentation
- setup-windows.ps1: PowerShell setup script for Windows
- setup-windows.bat: Batch file launcher for Windows setup
Documentation includes:
- Step-by-step installation instructions
- Troubleshooting guides
- Architecture overview
- Feature assessment and recommendations
- Deployment strategies
- Cost analysis
- Customization roadmap
Description
Type of Change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Feature (non-breaking change which adds functionality)
- [ ] Improvement (change that would cause existing functionality to not work as expected)
- [ ] Code refactoring
- [ ] Performance improvements
- [ ] Documentation update
Screenshots and Media (if applicable)
Test Scenarios
References
[!NOTE] Adds a full documentation suite and Windows setup scripts covering local setup, rebranding, architecture, deployment, and troubleshooting.
- Documentation:
- Adds
SETUP_GUIDE.mdwith cross-platform local dev setup, troubleshooting, workflows, and architecture overview.- Adds
QUICK_START_WINDOWS.mdfor 30βmin Windows setup with common issue fixes.- Adds
REBRANDING_GUIDE.mddetailing branding changes, feature assessment/removal, customization, and deployment strategy.- Adds
PROJECT_OVERVIEW.mdwith high-level architecture, tech stack, features, scalability, security, and cost analysis.- Adds
README_DOCUMENTATION.mdas a navigation hub with quick references and checklists.- Tooling/Scripts (Windows):
- Adds
setup-windows.ps1to verify prerequisites, create.envfiles, generate DjangoSECRET_KEY, enablepnpm, and install deps.- Adds
setup-windows.batlauncher to run the PowerShell setup script.Written by Cursor Bugbot for commit 14645dd8056d0ef0635b18fa21ffcce8194f0126. This will update automatically on new commits. Configure here.
Summary by CodeRabbit
-
Documentation
- Added comprehensive project overview and architecture documentation.
- Added Windows quick-start guide with setup instructions and troubleshooting.
- Added local development setup guide for all platforms.
- Added rebranding and customization guide with feature roadmap.
- Added documentation index with recommended reading order.
-
Chores
- Added Windows setup automation scripts for streamlined environment configuration.
βοΈ Tip: You can customize this high-level summary in your review settings.
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.
Walkthrough
This PR introduces comprehensive documentation and Windows development environment setup automation for the Plane project. It adds five new documentation files covering project overview, setup guides, rebranding guidance, and Windows quick-start instructions, along with two new Windows setup scripts (batch and PowerShell) to automate environment initialization and prerequisite validation.
Changes
| Cohort / File(s) | Summary |
|---|---|
Documentation Files PROJECT_OVERVIEW.md, README_DOCUMENTATION.md, REBRANDING_GUIDE.md, SETUP_GUIDE.md, QUICK_START_WINDOWS.md |
Comprehensive documentation covering project architecture, setup procedures, feature inventory, rebranding roadmap, technology stack, deployment strategies, and Windows-specific quick-start guidance |
Windows Setup Automation setup-windows.bat, setup-windows.ps1 |
Batch entry point and PowerShell setup script with functions for environment variable copying, secret key generation, and prerequisite validation (Node.js, Docker); automates .env population across services |
Sequence Diagram(s)
sequenceDiagram
participant User
participant Batch as setup-windows.bat
participant PS as setup-windows.ps1
participant System
User->>Batch: Execute setup-windows.bat
Batch->>PS: Invoke PowerShell script
PS->>System: Validate Node.js version
PS->>System: Validate Docker installation
PS->>System: Check Docker daemon
alt Prerequisites Valid
PS->>PS: Generate Django SECRET_KEY
PS->>System: Copy .env files to services
PS->>System: Enable pnpm via Corepack
PS->>System: Install Node.js dependencies
PS->>User: Display summary & next steps
else Prerequisites Missing
PS->>User: Display error message
PS->>Batch: Exit with code 1
end
Estimated code review effort
π― 2 (Simple) | β±οΈ ~10 minutes
- setup-windows.ps1: Review helper functions (
Copy-EnvFile,New-SecretKey), environment variable handling, and prerequisite validation logic for edge cases - Documentation files: Verify internal link consistency, command accuracy, and completeness of setup instructions across platforms
- setup-windows.bat: Confirm error handling paths and PowerShell invocation correctness
Poem
π° Welcome scripts and guides so bright,
Setup paths now shining in Windows light,
Documentation weaves a wizard's tale,
From zero to developer, none shall fail,
A rabbit's gift: the easiest sail! π
Pre-merge checks and finishing touches
β Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | β Passed | The title clearly describes the main change: adding comprehensive documentation guides for setup and rebranding, which matches the actual files added. |
| Description check | β Passed | The description covers the files added and their purposes, but the Type of Change section has no checkboxes selected despite the PR being a documentation update. |
| Docstring Coverage | β Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
β¨ Finishing touches
π§ͺ Generate unit tests (beta)
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
[!TIP]
π Customizable high-level summaries are now available in beta!
You can now customize how CodeRabbit generates the high-level summary in your pull requests β including its content, structure, tone, and formatting.
- Provide your own instructions using the
high_level_summary_instructionssetting.- Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
- Use
high_level_summary_in_walkthroughto move the summary from the description to the walkthrough section.Example instruction:
"Divide the high-level summary into five sections:
- π Description β Summarize the main change in 50β60 words, explaining what was done.
- π References β List relevant issues, discussions, documentation, or related PRs.
- π¦ Dependencies & Requirements β Mention any new/updated dependencies, environment variable changes, or configuration updates.
- π Contributor Summary β Include a Markdown table showing contributions:
| Contributor | Lines Added | Lines Removed | Files Changed |- βοΈ Additional Notes β Add any extra reviewer context. Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.
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 @coderabbitai help to get the list of available commands and usage tips.