Skip to content

docs: 📝 Clarify contracts and adapters#10

Merged
haskou merged 5 commits into
mainfrom
fix/clarify-contracts-and-adapters
Jun 25, 2026
Merged

docs: 📝 Clarify contracts and adapters#10
haskou merged 5 commits into
mainfrom
fix/clarify-contracts-and-adapters

Conversation

@haskou

@haskou haskou commented Jun 25, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a package map explaining core, contracts/domain primitives and optional adapters.
  • Reworks installation by adapter group instead of listing random packages without context.
  • Reorganizes VitePress reference navigation by Kernel, Contracts/Domain, Pub/Sub, DB, UI, Scheduling, Logs and WebSocket.
  • Expands Kernel, DependencyInjection, ConsoleKernelLogger, Route and adapters docs with clearer responsibilities and options.

Validation

  • yarn format:check
  • yarn lint
  • yarn typecheck
  • yarn test:coverage (100%)
  • yarn docs:build
  • yarn --cwd example typecheck
  • yarn build

@haskou haskou merged commit 8b2f17c into main Jun 25, 2026
6 checks passed
@haskou haskou deleted the fix/clarify-contracts-and-adapters branch June 25, 2026 22:14

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2c8c74b4b8

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/reference/kernel.md

```ts
await kernel.dependencyInjection({
containerBuild: process.env.NODE_ENV === 'production',

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Keep containerBuild disabled in production

This example inverts the intended build/load flow: containerBuild: true regenerates services.yaml from sourceDirectory, while false loads the generated YAML, and the existing DI guide uses NODE_ENV !== 'production'. In production deployments that ship dist plus the generated YAML but not the TS src tree, following this snippet will try to scan/rebuild at startup and fail instead of loading the container.

Useful? React with 👍 / 👎.

github-actions Bot added a commit that referenced this pull request Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant