Skip to main content

Feature: {Feature Name}

Template — copy this page into the appropriate section (usually features/) when documenting a new capability. Delete this callout when you're done.

Statusexperimental / beta / stable
Owner@your-github-handle
Feature flagSCRYON_..._ENABLED (or "none")
Introduced inPR #N
Depends onList other features / external providers.

What it does

A 1-3 sentence summary. What does this feature do for the user?

Why it exists

The problem it solves and the alternatives we considered. Cite the issue / discussion that motivated it.

How it works

Step-by-step or a small diagram.

┌──────┐ ┌──────┐
│ A │──▶│ B │ ─...
└──────┘ └──────┘

Components

ComponentFilePurpose
XxxServicecom/scryon/.../XxxService.javaWhat it does.

Configuration

VariableDefaultNotes
SCRYON_..._ENABLEDfalseMaster switch.
SCRYON_..._FOOWhat it tunes.

Privacy

Anything stored, sent to providers, or exposed via APIs that touches user content. Link to the Privacy & security page.

Failure modes

FailureBehaviour
Provider downSoft fail / hard fail / fall back.
Bad input400 / 422 / silent skip.

Telemetry

Metrics, logs, and traces this feature emits.

  • scryon.xxx.duration (timer)
  • event=XXX_STARTED callId=... ...
  • Span: pipeline.xxx

Code map

FileWhat
XxxService.javaCore logic.
XxxController.javaREST surface (if any).
XxxClient.javaExternal provider integration.
XxxTest.javaTests.

What this feature is NOT

Set expectations explicitly. Useful for keeping scope creep out of follow-ups.

  • ❌ Not a replacement for X.
  • ❌ Not intended for Y.
  • [Other feature](other-feature.md) — link to a related feature doc.
  • Relevant ADR