Skip to content

docs(examples): add financial-research scaffold README#121

Open
kaiicheng wants to merge 3 commits into
arklexai:mainfrom
kaiicheng:examples/add-financial-research
Open

docs(examples): add financial-research scaffold README#121
kaiicheng wants to merge 3 commits into
arklexai:mainfrom
kaiicheng:examples/add-financial-research

Conversation

@kaiicheng

Copy link
Copy Markdown

Summary

Add an initial scaffold README for a future financial-research example under examples/.
The goal is to establish a starting point for a finance-oriented ArkSim example focused on research and analysis workflows.

Changes

  • added examples/financial-research/README.md
  • described the intended use cases for the example
  • documented the current scope and possible future additions

Documentation

  • No additional docs needed (this PR only adds an example scaffold README)

How to Test

  • Manual verification: verified that examples/financial-research/README.md is included in the PR diff

Notes

This PR is intentionally minimal and only introduces the initial scaffold.
Future follow-ups may add configs, scenarios, metrics, and runnable example assets.

@kaiicheng kaiicheng requested a review from a team as a code owner March 24, 2026 04:35

@itsarbit itsarbit left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey Kai, thanks for putting this together. I think the financial research use case is interesting, but this PR is more of a design proposal than a working example.

Our pattern for examples in this repo is: working code (config.yaml, custom_agent.py, scenarios.json) shipped together with a README that shows how to run it. This README has the setup section commented out and no actual code to go with it.

Would you be open to converting this to a GitHub Discussion instead? That way we can iterate on the design together, and once the implementation is ready, open a proper PR with code + docs together. Happy to help spec it out in the discussion.

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.

2 participants