Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/serverless/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder for PoC
Copy link

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This README currently contains only a placeholder line. If this PR is intended to land, please either replace this with real documentation for docs/serverless (what the directory is for, how it’s generated/consumed, and any maintenance/backport guidance) or remove the file/directory before merging so we don’t ship placeholder docs.

Suggested change
placeholder for PoC
# Serverless Documentation
This directory contains documentation for the project’s serverless components
(for example, Functions-as-a-Service, serverless APIs, and related workflows).
It is intended to help contributors and operators understand how the
serverless parts of the system are structured, deployed, and maintained.
## Contents of this directory
Typical content in `docs/serverless` includes:
- High-level architecture overviews for serverless services.
- API and event contract documentation for serverless functions.
- Deployment and configuration notes (for example, environment variables,
IAM/permissions, and resource limits).
- Operational runbooks or troubleshooting notes specific to serverless
components.
If you add new serverless features or change existing ones, update or extend
the documentation in this directory accordingly.
## How these docs are generated and consumed
Unless otherwise noted in subdirectories, the files here are **manually
maintained** Markdown documents checked into source control.
These docs are typically consumed in the following ways:
- Viewed directly in the repository (e.g., on GitHub or in a code browser).
- Included in internal or external documentation sites that render Markdown.
- Referenced from design docs, runbooks, and onboarding materials for teams
working on serverless features.
If your environment uses a documentation build pipeline (for example, a
static-site generator or internal docs portal), ensure that `docs/serverless`
is wired into that pipeline according to project standards (for example, via
a docs configuration file or build script). Any such integration-specific
details should be documented in this file or in a dedicated `CONTRIBUTING.md`
in this directory.
## Maintenance and backport guidance
- **Keep docs in sync with code**: Whenever you add, modify, or remove
serverless functions, triggers, or configuration, update the relevant
Markdown files here in the same pull request.
- **Document breaking changes**: For any breaking change to a serverless API,
event schema, or behavior, add a clear description of the change, expected
impact, and required migration steps.
- **Versioned branches / backports**: When backporting serverless changes to
release branches, also backport the corresponding documentation updates in
`docs/serverless` so that each maintained branch has accurate docs for its
serverless behavior.
- **Structure**: Prefer adding new Markdown files (for example,
`architecture.md`, `deployment.md`, `runbooks.md`, or per-service docs) over
heavily growing a single document. This keeps information discoverable and
easier to review.
Before merging a pull request that touches serverless code, check this
directory to ensure documentation is present and up to date, and avoid adding
placeholder text or empty stubs.

Copilot uses AI. Check for mistakes.
Loading