Add repository-wide markdown documentation

[aamoghS]

The repo had a database-focused root README and leftover create-next-app READMEs on both sites. This adds a docs/ tree that matches how the monorepo actually works, and points package/site READMEs at it.

What’s in docs/

• Getting started — pnpm, local Postgres on 5433, env minimums, first admin
• Architecture — club vs hackathon split, request path, auth, payments, cache, deploy split
• Packages — @query/api (every tRPC namespace and role gate), @query/auth, @query/db (schema + the one-off club-table SQL), @query/ui
• Sites — mainweb public + portal routes and API handlers; Hacklytics 2027 static export and interest CTA
• Operations — env vars, App Hosting + Firebase Hosting, GitHub Actions, security controls, tests
• Glossary — membership, volunteer vs staff, initiatives vs hackathon projects, current edition

Root README.md is now a short landing page. CONTRIBUTING.md links to docs/contributing.md.

Notes

• Long schema/migration guidance moved from the root README into docs/packages/db.md (not dropped).
• Production origins are not hardcoded; use AUTH_URL / NEXTAUTH_URL.

  

[github-actions]

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

[github-actions]

Visit the preview URL for this PR (updated for commit ca73f27):

https://hacklytics2027--pr-352-n8l0njib.web.app

_{(expires Sun, 23 Aug 2026 15:32:18 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: c48ba34db61581e25fe2978355160b5eefe0e83f}

[greptile-apps]

Greptile Summary

The PR replaces stale and database-focused READMEs with a repository-wide documentation tree covering onboarding, architecture, packages, sites, operations, and contribution workflows.

• Adds a central documentation index and focused package, site, and operations references.
• Preserves the existing one-off database migration guidance under the database package documentation.
• Replaces package and site starter READMEs with concise links and workspace-specific commands.
• Adds cross-references from the root README, contribution guide, and GCP setup guide.

Confidence Score: 5/5

The documentation-only PR appears safe to merge, with no actionable changed-code defects identified.

The new documentation was checked against the relevant manifests, configuration, workflows, middleware, and schemas, and the concrete inconsistencies encountered were either pre-existing or explicitly handled by the new guidance.

Important Files Changed

Filename	Overview
README.md	Replaces the database-heavy root guide with a concise monorepo overview, verified quick-start commands, architecture summary, and documentation links.
docs/getting-started.md	Adds onboarding instructions whose package versions, workspace scripts, database port, environment names, and admin role values align with repository configuration.
docs/architecture.md	Documents the two-site architecture, package request path, domain split, authentication, payments, caching, and deployment topology.
docs/operations/deployment.md	Describes App Hosting and Firebase Hosting behavior consistently with the deployment configuration and workflows, including a fallback for the absent secret-sync script.
docs/operations/environment.md	Centralizes runtime environment-variable guidance and accurately distinguishes the SMTP mail configuration from the stale Resend reference.
docs/operations/security.md	Maps existing authorization, input validation, rate limiting, HTTP, payment, audit, and secret controls without changing runtime behavior.
docs/packages/api.md	Adds a detailed router and middleware reference consistent with the package’s composed namespaces, role gates, pricing, and cache behavior.
docs/packages/db.md	Moves and expands database guidance, retaining the guarded one-off club-table migration and documenting schema and membership-service behavior.

_{Reviews (1): Last reviewed commit: "Add repository documentation covering pa..." | Re-trigger Greptile}