docs(examples): add financial-research scaffold README#121
Open
kaiicheng wants to merge 3 commits into
Open
Conversation
itsarbit
reviewed
Apr 10, 2026
itsarbit
left a comment
Contributor
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add an initial scaffold README for a future
financial-researchexample underexamples/.The goal is to establish a starting point for a finance-oriented ArkSim example focused on research and analysis workflows.
Changes
examples/financial-research/README.mdDocumentation
How to Test
examples/financial-research/README.mdis included in the PR diffNotes
This PR is intentionally minimal and only introduces the initial scaffold.
Future follow-ups may add configs, scenarios, metrics, and runnable example assets.