feat: unified local dev setup with optional services#2052
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
827191c to
d045658
Compare
There was a problem hiding this comment.
PR Review Summary
(1) Total Issues | Risk: High
🔴❗ Critical (1) ❗🔴
Inline Comments:
- 🔴 Critical:
agents-docs/content/community/contributing/overview.mdx:47-52Unresolved merge conflict markers in documentation
💭 Consider (0) 💭
No consider items.
🚫 REQUEST CHANGES
Summary: This PR introduces a clean architectural improvement by moving the optional services clone location from a sibling directory to inside the project (.optional-services/), improving discoverability and project self-containment. The documentation updates and gitignore entries are consistent across all surfaces.
However, the PR cannot be merged in its current state due to unresolved Git merge conflict markers in agents-docs/content/community/contributing/overview.mdx (lines 47-52). These will render as literal garbage text in the published documentation. Please resolve the conflict by keeping one version of the Tip content.
Once the merge conflict is resolved, this PR looks good to ship! 🚀
Discarded (5)
| Location | Issue | Reason Discarded |
|---|---|---|
deployment/(docker)/*.mdx |
Deployment docs use inkeep-external-services vs .optional-services/ |
Intentional design — deployment docs are for standalone server contexts, not local dev inside the project |
package.json:75-78 |
Command naming pattern (setup-dev:optional vs optional:*) could be more consistent |
Already documented in AGENTS.md, intentional grouping of lifecycle commands |
scripts/setup-optional.sh:41-44 |
Git pull warning could be more actionable | Pre-existing code not modified by this PR |
| Scripts sync | Scripts are correctly synchronized | Positive finding, not actionable |
| Gitignore/docs | Consistent messaging verified | Positive finding, not actionable |
Reviewers (4)
| Reviewer | Returned | Main Findings | Consider | While You're Here | Inline Comments | Pending Recs | Discarded |
|---|---|---|---|---|---|---|---|
pr-review-docs |
1 | 0 | 0 | 0 | 1 | 0 | 0 |
pr-review-devops |
3 | 0 | 0 | 0 | 0 | 0 | 3 |
pr-review-product |
4 | 0 | 0 | 0 | 0 | 0 | 4 |
pr-review-consistency |
2 | 0 | 0 | 0 | 0 | 0 | 2 |
| Total | 10 | 0 | 0 | 0 | 1 | 0 | 9 |
Note: The merge conflict finding was reported by all 4 reviewers (deduplicated to 1). Most other findings were positive validations or intentional design choices.
Add pnpm setup-dev:optional — bootstrap shim that clones agents-optional-local-dev into .optional-services/, delegates to its setup script, and wires Nango + SigNoz + OTEL Collector + Jaeger into the caller's .env. - Add lifecycle commands: optional:stop, optional:status, optional:reset - Auto-sync shim to create-agents-template via lint-staged - Update docs (traces, Nango, contributing) with automated + manual setup sections - Add snippets for shared prereq and lifecycle content - Fix stale .env.example references in deployment docs - Add troubleshooting and upgrading entries Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
d045658 to
aabd061
Compare
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Fixed the merge conflict markers in |
There was a problem hiding this comment.
PR Review Summary
(0) Total Issues | Risk: Low
🔴❗ Critical (0) ❗🔴
No critical issues.
🟠⚠️ Major (0) 🟠⚠️
No major issues.
🟡 Minor (0) 🟡
No minor issues.
💭 Consider (0) 💭
No consider items.
🕐 Pending Recommendations (0)
No pending recommendations — the previous merge conflict issue was resolved in commit d710f10.
✅ APPROVE
Summary: The merge conflict markers flagged in the previous review have been successfully resolved. The PR now cleanly updates the default optional services clone location from ../agents-optional-local-dev to .optional-services/ across all relevant surfaces:
- ✅ Scripts (
scripts/setup-optional.sh,create-agents-template/scripts/setup-optional.sh) — identical and correctly updated - ✅ Documentation (contributing, traces, nango) — consistent path references throughout
- ✅ Gitignore files — properly exclude
.optional-services/ - ✅ Environment variable override (
OPTIONAL_SERVICES_DIR) preserved for flexibility
This is a clean architectural improvement that makes the project more self-contained and discoverable. Ship it! 🚀
Discarded (0)
No discarded items.
Reviewers (4)
| Reviewer | Returned | Main Findings | Consider | While You're Here | Inline Comments | Pending Recs | Discarded |
|---|---|---|---|---|---|---|---|
pr-review-docs |
0 | 0 | 0 | 0 | 0 | 0 | 0 |
pr-review-devops |
0 | 0 | 0 | 0 | 0 | 0 | 0 |
pr-review-consistency |
0 | 0 | 0 | 0 | 0 | 0 | 0 |
pr-review-product |
0 | 0 | 0 | 0 | 0 | 0 | 0 |
| Total | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Note: All reviewers confirmed the changes are clean and consistent. The previous critical issue (merge conflict markers) was verified as resolved.
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Inkeep Agent Framework Docs' |
Summary
pnpm setup-dev:optional— thin bootstrap shim that clones agents-optional-local-dev into.optional-services/, delegates to itsscripts/setup.sh, and wires Nango + SigNoz + OTEL Collector + Jaeger into the caller's.envpnpm optional:stop,pnpm optional:status,pnpm optional:reset.optional-services/(gitignored dotfolder inside the project, overridable viaOPTIONAL_SERVICES_DIR)create-agents-template/via lint-staged (same pattern asgenerate-jwt-keys.sh).env.examplereferences in 4 deployment docsChanges
Scripts:
scripts/setup-optional.sh— bootstrap shim (clone + delegate + env var passthrough)create-agents-template/scripts/setup-optional.sh— auto-synced copyDocs:
agents-docs/content/get-started/traces.mdx— automated/manual SigNoz setupagents-docs/content/typescript-sdk/credentials/nango.mdx— automated/manual Nango setupagents-docs/content/community/contributing/overview.mdx— optional services sectionagents-docs/_snippets/setup-dev-optional-*.mdx— shared prereq and lifecycle snippetsConfig:
.gitignore— add.optional-services/package.json— add 4 pnpm commands.env.example— add optional service env varsCompanion PR
inkeep/agents-optional-local-dev#8
Test plan
pnpm setup-dev:optionalclones into.optional-services/, starts 9 containers, writes 9 env varspnpm optional:statusshows running servicespnpm optional:stopstops servicespnpm optional:resetremoves data and re-runs setup.optional-services/does not appear ingit statusOPTIONAL_SERVICES_DIR=/tmp/custom pnpm setup-dev:optionalclones to custom pathdiff scripts/setup-optional.sh create-agents-template/scripts/setup-optional.sh— identical after lint-staged🤖 Generated with Claude Code