Skip to content

Home

Jump to bottom
Akshay B edited this page Mar 16, 2026 · 2 revisions

Pluck-It Documentation Hub

Welcome to the documentation home for contributors and maintainers. This hub is intentionally external-facing, focused on architecture and API behavior without sensitive deployment values.

Documentation metadata

  • Audience: external contributors
  • Last reviewed: 2026-03-16
  • Scope: architecture, integration boundaries, and runtime contracts
  • API contracts are documented separately for each service runtime.

Start Here (New Contributors)

If you are new to the project, use this sequence:

  1. Read the overall architecture intent in the client and API docs:
  2. Understand identity and access model:
  3. Review deployment and cloud dependencies before touching infra:
  4. Use the architecture map below to place each repo/path you are editing.

What this docs set intentionally excludes

  • Environment-specific secrets, credentials, and private keys
  • Exact tenant credentials and live internal service endpoints
  • Incident-sensitive runbooks for privileged platform credentials

If you need private operational details, contact the Pluck-It platform team for the internal runbook.

Architecture Map

flowchart TD
  U["Users / Mobile / Browser clients"]
  FE["PluckIt Client"]
  API["Dotnet Serverless Functions"]
  AUTH["Authentication and Identity"]
  PY["Python Serverless Functions"]
  QUEUE["Queue Storage (jobs)"]
  COSMOS["Cosmos DB"]
  BLOB["Blob Storage"]
  SWA["Static Web App"]
  TF["Terraform (Azure resources)"]

  U --> FE
  FE --> API
  FE --> SWA
  API --> AUTH
  API --> COSMOS
  API --> BLOB
  API --> QUEUE
  QUEUE --> PY
  PY --> COSMOS
  PY --> BLOB
  TF --> SWA
  TF --> API
  TF --> FE
Loading

Browse by Workstream

Contribution quality checks

  • Confirm the request you are changing has the correct runtime contract owner.
  • Re-check service-specific auth expectations against Authentication and Identity.
  • Ensure external docs do not include raw credentials, secrets, or private identifiers.

First Task Checklist

  • Confirm which part of the system you are changing (client, function, identity, or infra).
  • Read the corresponding doc and any linked files before editing.
  • If your change touches Azure resources, follow deployment notes in Terraform first.
  • For cross-cutting changes, use the architecture map and verify request flow across components.

Clone this wiki locally