[sriramveeraghanta]

Description

Audited every Markdown doc in the repo against the current code and config, and fixed what had drifted. Every change was checked against the source it describes (scripts, compose files, env files, package exports, CI workflows).

• README / CONTRIBUTING / AGENTS / SECURITY
  • Correct requirements: Node 22.22+, Postgres 15, Valkey, RabbitMQ, pnpm via Corepack. Explain what setup.sh does and list all local ports.
  • New "Submitting a pull request" section: target preview, checks to run, migrations lockfile, copyright header.
  • Rewrote the translations guide for the per-namespace locale files and sync:check (the old translations.json and importLanguageFile setup no longer exists).
  • Point community conversation to forum.plane.so and GitHub issues (we don't use GitHub Discussions). The issue-template "Help and support" link had no url, so GitHub wasn't showing it.
  • Mention GitHub private vulnerability reporting. Replace the 404 makeplane/docs link and stale issue-link assignees. Make links relative.
• Tooling docs: docs/linting.md and COPYRIGHT_CHECK.md now match .oxlintrc.json, oxfmt and the CI copyright check. The Copilot TS/bash instructions now reflect the repo's legacy decorators, es2023/ES2022 libs and turbo scripts.
• apps/api:
  • Test docs: fixed broken links, the test file name and the sign-in route. Removed the auth_client fixture, which doesn't exist. Documented the mock_redis / mock_celery fixtures that fix: deployment script and test tooling bugs found in docs audit #10264 registers and dropped mock_elasticsearch. Switched commands to uv run.
  • openapi README: removed names that don't exist and documented ENABLE_DRF_SPECTACULAR.
  • exporters README: noted that production exports use plane.utils.porters and fixed helper/field names.
  • Marked the Django 5.2 plan as done (chore: upgrade Django 4.2 → 5.2 #9325).
• deployments:
  • CLI: menu labels and flow, required secret keys, HTTPS and external-service vars, SMTP via God mode, backup/restore output including RabbitMQ, and the migration script URL.
  • AIO: services and ports (web/admin are static files behind Caddy), required secrets in the IP example, what build.sh actually does, and env precedence with /app/plane.env.
  • Kubernetes: Helm install commands.
• packages: decorators, logger and editor READMEs rewritten from the real exports (registerController, loggerMiddleware, *EditorWithRef). Fixed jscodeshift usage in the codemods doc and removed the non-existent bg-surface-3 token from the tailwind-config guide. Corrected locale counts and skill names in .claude/skills.

The CONTRIBUTING setup section keeps the env-var table added in #9411; this PR folds the extra setup.sh details into it.

Code bugs found during the audit (swarm exit option, CLI env vars that have no effect, broken run_tests.sh, unloaded test fixtures) are fixed in #10264. Merge #10264 first: the test docs here describe its fixtures as available.

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

• Follow CONTRIBUTING on a fresh clone: ./setup.sh, docker compose -f docker-compose-local.yml up, pnpm dev, then open http://localhost:3001/god-mode/ and http://localhost:3000.
• Run the commands documented in apps/api/tests/RUNNING_TESTS.md, including the single-file run (plane/tests/unit/models/test_workspace_model.py).
• Run pnpm --filter=@plane/i18n sync:check as described in the translations section.
• Open the issue chooser (/issues/new/choose) after merge and check the "Help and support" link goes to forum.plane.so.
• Click through README/CONTRIBUTING links on GitHub (all relative links and anchors were checked locally; external links return 200).
• Self-hosting: walk through deployments/cli/community/README.md with setup.sh and check the menu and backup output match.

References

• Depends on: fix: deployment script and test tooling bugs found in docs audit #10264 (code fixes; merge first)
• Related: docs: document DATABASE_URL, PORT, and REDIS_URL in CONTRIBUTING.md #9411 (CONTRIBUTING env vars), chore: upgrade Django 4.2 → 5.2 #9325 (Django 5.2), chore(api): manage Python dependencies with uv #9950 (uv)

Generated with Claude Code

[coderabbitai]

Caution

Review failed

The pull request is closed.

Pre-merge checks: 2

Failed checks: 2 inconclusive

Check name	Status	Explanation	Resolution
Title check		This assessment has not completed. The check will be retried on the next pre-merge check run.
Description check		This assessment has not completed. The check will be retried on the next pre-merge check run.

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

• X
• Mastodon
• Reddit
• LinkedIn