docs: api v2 and examples app setup

[supalarry]

What does this PR do?

Expands API v2 and platform examples app setup documentation to streamline local development, with clearer docs, pre-filled env examples, and a new secret generator script.

• Fixes docs: api v2, atoms, examples app setup #27235

Summary of Changes

• New README-PLATFORM.md: Step-by-step local setup guide for API v2 + atoms examples app (OAuth/OAuth2, Stripe, Apple Calendar)
• New generate-secrets script: Creates OAuth2 client secrets and writes them to .generated-secrets file (not logged to console for security)
• Updated API v2 README: Simplified to a concise local dev guide; fixed env file path typo (apps/api/v2/.env instead of apps/api/v2.env)
• Enriched .env.example files: Pre-filled with sensible local defaults including DATABASE_DIRECT_URL and updated GET_LICENSE_KEY_URL

Mandatory Tasks (DO NOT REMOVE)

• I have self-reviewed the code (A decent size PR without self-review might be rejected).
• I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. N/A - this PR is documentation itself.
• I confirm automated tests are in place that prove my fix is effective or that my feature works. N/A - documentation only.

How should this be tested?

1. Follow the steps in apps/api/v2/README.md to set up API v2 locally
2. Run yarn generate-secrets in apps/api/v2 and verify secrets are written to .generated-secrets file (not logged to console)
3. Follow apps/api/v2/README-PLATFORM.md to set up the platform examples app
4. Verify the examples app can authenticate with API v2 using the generated secrets

Checklist

• My code follows the style guidelines of this project
• I have checked if my changes generate no new warnings
• My PR is not too large

---

Link to Devin run: https://app.devin.ai/sessions/eac833c0aaf84b7a83c3885abf8a2f07
Requested by: unknown ()

[linear]

CAL-7125 docs: api v2, atoms, examples app setup

[cubic-dev-ai]

3 issues found across 6 files

Prompt for AI agents (all issues)

Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="apps/api/v2/README-PLATFORM.md">

<violation number="1" location="apps/api/v2/README-PLATFORM.md:31">
P2: Replace the concrete OAuth secret values in the docs with placeholders (e.g., `<PLAINTEXT_SECRET>`). Shipping real-looking secrets in documentation can lead to accidental exposure or reuse.

(Based on your team's feedback about avoiding exposing actual OAuth client secrets.) [FEEDBACK_USED]</violation>
</file>

<file name="apps/api/v2/README.md">

<violation number="1" location="apps/api/v2/README.md:16">
P2: The env file rename path is incorrect (`apps/api/v2.env` instead of `apps/api/v2/.env`), which will mislead developers and cause the app to miss the env file. Update the path to include the directory separator.</violation>
</file>

<file name="apps/api/v2/scripts/generate-secrets.ts">

<violation number="1" location="apps/api/v2/scripts/generate-secrets.ts:5">
P1: Rule violated: **Avoid Logging Sensitive Information**

Remove logging of generated secrets to avoid exposing sensitive authentication data in logs.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

[github-actions]

Devin AI is addressing Cubic AI's review feedback

A Devin session has been created to address the issues identified by Cubic AI.

View Devin Session