Skip to content

docs: add agent development guide #262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vcfgv merged 5 commits into from
Oct 30, 2025
+549 −2
Merged

docs: add agent development guide #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
090b1c1
docs: update CONTRIBUTING.md and add agent development guide
vcfgv Oct 30, 2025
839ffae
fix: reorder imports in agent module for clarity
vcfgv Oct 30, 2025
a866b68
docs: simplify model configuration section in agent contribution guide
vcfgv Oct 30, 2025
8eb5054
docs: add agent processing flow essentials to contribution guide
vcfgv Oct 30, 2025
adcbd6d
docs: enhance agent contribution guide with AI assistant bootstrappin…
vcfgv Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ We welcome code contributions! See the [Development Setup](#development-setup) s
***Reference Doc***

> Multi-agent system architecture: [CORE_ARCHITECTURE](../docs/CORE_ARCHITECTURE.md)
> Configuration documentation: [CONFIGURATION_GUIDE](../docs/CONFIGURATION_GUIDE.md)
> Configuration documentation: [CONFIGURATION_GUIDE](../docs/CONFIGURATION_GUIDE.md)
> Agent development guide: [CONTRIBUTING_AN_AGENT](../docs/CONTRIBUTING_AN_AGENT.md)


## Development Setup
Expand Down Expand Up @@ -93,6 +94,31 @@ bun install

### Backend and Agents

For detailed information on building and contributing agents, see the [Agent Development Guide](../docs/CONTRIBUTING_AN_AGENT.md).

Quick start:

**Run the API server:**

```bash
cd python
python -m valuecell.server.main
```

**Run the Research Agent:**

```bash
cd python
python -m valuecell.agents.research_agent
```

> [!TIP]
> Set your environment first. At minimum, configure `OPENROUTER_API_KEY` (or `GOOGLE_API_KEY`) and `SEC_EMAIL`. See [Configuration Guide](../docs/CONFIGURATION_GUIDE.md).

### Code Style

### Backend and Agents

This section shows how to run the backend locally and build new agents.

#### Architecture at a glance
Expand Down
Loading