Skip to content

fix(config): align configuration defaults and API documentation - #28

Open
thecodacus wants to merge 1 commit into
mainfrom
fix/issue-9-config-docs
Open

thecodacus wants to merge 1 commit into
mainfrom
fix/issue-9-config-docs

Conversation

@thecodacus

Copy link
Copy Markdown
Owner

Configuration examples pinned a provider instead of inheriting the configured pi default, explicit zero resource limits silently became defaults, and several API and channel documents described older behavior. This aligns the examples and references with current runtime behavior, forwards container resource settings through Compose, validates positive limits, and lets the audit API return the full retained 2,000 entries.

The documentation covers configuration precedence, native/container paths and environment forwarding, the current SSE replay protocol, lazy session startup, channel activation, and the agent, people, MCP, skills and routines routes. The legacy workspace fallback is handled separately in #21.

Validation: server TypeScript build, executor resource-limit regression tests, and VitePress production build passed. No deployment changes were applied.

Fixes #9

@coderabbitai

coderabbitai Bot commented Sep 15, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 34 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: d8d7d6f4-1921-4e8c-9974-fe008adc52db

📥 Commits

Reviewing files that changed from the base of the PR and between 0dcb312 and 500d875.

📒 Files selected for processing (14)
  • .env.example
  • README.md
  • channels/README.md
  • docker-compose.portainer.yml
  • docker-compose.yml
  • docs/reference/api.md
  • docs/reference/architecture.md
  • docs/reference/configuration.md
  • server/src/api/people.ts
  • server/src/db.ts
  • server/src/executors/index.ts
  • server/src/executors/limits.ts
  • server/src/index.ts
  • tests/executor-limits.test.mts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

Config & docs audit: compose env gaps, pinned defaults drift, and an 11-item docs-parity sweep (multi-day deep dive)

1 participant