docs: add local development section#1318
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a “Developing Locally” section to the main README to document how to run Solace Agent Mesh from a source checkout, aligning with issue #1259.
Changes:
- Added a top-of-README navigation link to the new “Developing Locally” section.
- Documented local setup steps (clone, venv, editable install, Playwright install, VS Code debug config usage, and a CLI run example).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### 5. Run from the terminal when needed | ||
|
|
||
| ```bash | ||
| sam run examples/agents/orchestrator_example.yaml examples/agents/a2a_agents_example.yaml examples/gateways/webui_gateway_example.yaml examples/services/platform_service_example.yaml |
There was a problem hiding this comment.
The sam run … example stack (and the SAM VS Code launch config that uses the same args) relies on required environment variables (e.g., LLM_SERVICE_ENDPOINT, LLM_SERVICE_API_KEY, LLM_SERVICE_PLANNING_MODEL_NAME, LLM_SERVICE_GENERAL_MODEL_NAME, NAMESPACE, and WebUI’s SESSION_SECRET_KEY). Since these have no defaults in examples/shared_config.yaml / examples/gateways/webui_gateway_example.yaml, the instructions here will fail unless the reader sets them. Consider adding a short step that lists the minimal required env vars (or points to the relevant docs pages) and mentions how to load them (export in shell / VS Code envFile).
fixes #1259