chore(readme): trim readme, add more envvar info

[waleedlatif1]

Summary

• trim readme, add more envvar info

Type of Change

• Documentation

Testing

Tested manually

Checklist

• Code follows project style guidelines
• Self-reviewed my changes
• Tests added/updated and passing
• No new warnings introduced
• I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

[vercel]

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

Project	Deployment	Review	Updated (UTC)
docs	Ready	Preview, Comment	Jan 13, 2026 6:30pm

[greptile-apps]

Greptile Summary

This PR trims verbose documentation sections in the README and self-hosting guide while adding clarification on environment variables required for self-hosted deployments. The changes improve readability by consolidating repetitive instructions, adding Cursor integration for guided setup, and explicitly documenting three encryption keys (ENCRYPTION_KEY, INTERNAL_API_SECRET, API_ENCRYPTION_KEY) that are now highlighted in the environment variables table. All documented variables align with the actual env.ts configuration file definitions.

Confidence Score: 5/5

• Documentation-only changes with no code impact - safe to merge
• This is a pure documentation PR with no code changes. The modifications include: (1) trimming verbose setup instructions while maintaining accuracy, (2) adding a Cursor integration badge for improved UX, (3) clarifying environment variable requirements with an updated table. All documented environment variables are verified to exist in env.ts with correct descriptions. The changes improve developer experience through better organization and clearer guidance, with zero risk of introducing bugs or breaking changes.
• No files require special attention

Important Files Changed

Filename	Overview
README.md	Documentation update that trims verbose README sections and adds more explicit environment variable information. Changes simplify setup instructions, consolidate repetitive content, and update the environment variables table with three newly clarified encryption keys (ENCRYPTION_KEY, INTERNAL_API_SECRET, API_ENCRYPTION_KEY). All environment variables mentioned align with env.ts definitions.
apps/docs/content/docs/en/self-hosting/index.mdx	Documentation page updated with Cursor setup badge integration and minor formatting. The addition of the interactive setup link improves UX by offering guided setup through Cursor. No functional issues detected.

Sequence Diagram

sequenceDiagram
    actor Dev as Developer
    participant README as README.md
    participant DocSite as Self-Hosting Docs
    participant EnvConfig as env.ts Config

    Dev->>README: Visit setup instructions
    README->>Dev: Streamlined instructions<br/>+ Cursor badge
    Dev->>README: Check environment variables
    README->>EnvConfig: Variables documented in table
    EnvConfig-->>README: Validates ENCRYPTION_KEY,<br/>INTERNAL_API_SECRET,<br/>API_ENCRYPTION_KEY
    
    Dev->>DocSite: Visit self-hosting guide
    DocSite->>Dev: Same setup badge<br/>for quick start
    Note over Dev,EnvConfig: Improved DX: Clearer docs<br/>+ Consistent info across pages

Loading