RecSys Suite

RecSys is an auditable recommendation system suite with deterministic ranking, versioned artifact rollout, and offline evaluation support.

Components

Component	Path	Purpose
recsys-service	api/	HTTP API for recommendations, admin config/rules, auth, exposure logging, and OpenAPI artifacts.
recsys-algo	recsys-algo/	Deterministic ranking core used by the service and examples.
recsys-pipelines	recsys-pipelines/	Offline jobs that build and publish versioned artifacts.
recsys-eval	recsys-eval/	Apache-2.0 evaluation tooling for regression gates, experiments, OPE, and reports.
recsys.app site	site/	Astro marketing site published at the root domain, with MkDocs technical docs mounted below it.

Documentation

Canonical technical documentation lives in docs/ and is rendered with mkdocs.yml. The public marketing site lives in site/ and publishes the technical docs under /documentation/technical/.

Start here:

• Developer quickstart
• Architecture
• Integration and evaluation
• Operations
• API reference
• Configuration reference
• Licensing
• Pricing

Local workflow

make env
make dev
make docs-check
make site-check

Expected result:

• make env creates api/.env if it is missing.
• make dev starts the Compose development stack.
• make docs-check validates links, spelling, and strict MkDocs build.
• make site-check validates the Astro marketing site, technical docs, combined build, and generated-site links.

Run the full repository gate when feasible:

make finalize

make finalize runs formatting, linting, tests, code generation, Markdown linting, and docs checks. It requires the same local tooling and Docker prerequisites as the module test targets.

Licensing

This is a multi-license repository:

• recsys-eval/** is Apache-2.0.
• All other paths are AGPL-3.0-only unless a file or closest directory-level notice states otherwise.

See Licensing and Pricing for commercial terms.